shield

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 8, 2019 License: Apache-2.0 Imports: 7 Imported by: 45

Documentation

Overview

Package shield provides the client and types for making API requests to AWS Shield.

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

See https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02 for more information on this service.

See shield package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/shield/

Using the Client

To use AWS Shield with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Shield client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/shield/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS Shield" // Service's name
	ServiceID   = "Shield"     // Service's identifier
	EndpointsID = "shield"     // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Exception that indicates the specified AttackId does not exist, or the requester
	// does not have the appropriate permissions to access the AttackId.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAccessDeniedForDependencyException for service response error code
	// "AccessDeniedForDependencyException".
	//
	// In order to grant the necessary access to the DDoS Response Team, the user
	// submitting AssociateDRTRole must have the iam:PassRole permission. This error
	// indicates the user did not have the appropriate permissions. For more information,
	// see Granting a User Permissions to Pass a Role to an AWS Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
	ErrCodeAccessDeniedForDependencyException = "AccessDeniedForDependencyException"

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// Exception that indicates that a problem occurred with the service infrastructure.
	// You can retry the request.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// Exception that indicates that the operation would not cause any change to
	// occur.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidPaginationTokenException for service response error code
	// "InvalidPaginationTokenException".
	//
	// Exception that indicates that the NextToken specified in the request is invalid.
	// Submit the request using the NextToken value that was returned in the response.
	ErrCodeInvalidPaginationTokenException = "InvalidPaginationTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// Exception that indicates that the parameters passed to the API are invalid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidResourceException for service response error code
	// "InvalidResourceException".
	//
	// Exception that indicates that the resource is invalid. You might not have
	// access to the resource, or the resource might not exist.
	ErrCodeInvalidResourceException = "InvalidResourceException"

	// ErrCodeLimitsExceededException for service response error code
	// "LimitsExceededException".
	//
	// Exception that indicates that the operation would exceed a limit.
	//
	// Type is the type of limit that would be exceeded.
	//
	// Limit is the threshold that would be exceeded.
	ErrCodeLimitsExceededException = "LimitsExceededException"

	// ErrCodeLockedSubscriptionException for service response error code
	// "LockedSubscriptionException".
	//
	// You are trying to update a subscription that has not yet completed the 1-year
	// commitment. You can change the AutoRenew parameter during the last 30 days
	// of your subscription. This exception indicates that you are attempting to
	// change AutoRenew prior to that period.
	ErrCodeLockedSubscriptionException = "LockedSubscriptionException"

	// ErrCodeNoAssociatedRoleException for service response error code
	// "NoAssociatedRoleException".
	//
	// The ARN of the role that you specifed does not exist.
	ErrCodeNoAssociatedRoleException = "NoAssociatedRoleException"

	// ErrCodeOptimisticLockException for service response error code
	// "OptimisticLockException".
	//
	// Exception that indicates that the protection state has been modified by another
	// client. You can retry the request.
	ErrCodeOptimisticLockException = "OptimisticLockException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// Exception indicating the specified resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Exception indicating the specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateDRTLogBucketInput added in v0.5.0 

type AssociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// LogBucket is a required field
	LogBucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDRTLogBucketInput) String added in v0.5.0 

func (s AssociateDRTLogBucketInput) String() string

String returns the string representation

func (*AssociateDRTLogBucketInput) Validate added in v0.5.0 

func (s *AssociateDRTLogBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateDRTLogBucketOutput added in v0.5.0 

type AssociateDRTLogBucketOutput struct {
	// contains filtered or unexported fields
}

func (AssociateDRTLogBucketOutput) String added in v0.5.0 

func (s AssociateDRTLogBucketOutput) String() string

String returns the string representation

type AssociateDRTLogBucketRequest added in v0.5.0 

type AssociateDRTLogBucketRequest struct {
	*aws.Request
	Input *AssociateDRTLogBucketInput
	Copy  func(*AssociateDRTLogBucketInput) AssociateDRTLogBucketRequest
}

AssociateDRTLogBucketRequest is the request type for the AssociateDRTLogBucket API operation.

func (AssociateDRTLogBucketRequest) Send added in v0.5.0 

func (r AssociateDRTLogBucketRequest) Send(ctx context.Context) (*AssociateDRTLogBucketResponse, error)

Send marshals and sends the AssociateDRTLogBucket API request.

type AssociateDRTLogBucketResponse added in v0.9.0 

type AssociateDRTLogBucketResponse struct {
	*AssociateDRTLogBucketOutput
	// contains filtered or unexported fields
}

AssociateDRTLogBucketResponse is the response type for the AssociateDRTLogBucket API operation.

func (*AssociateDRTLogBucketResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateDRTLogBucketResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateDRTLogBucket request.

type AssociateDRTRoleInput added in v0.5.0 

type AssociateDRTRoleInput struct {

	// The Amazon Resource Name (ARN) of the role the DRT will use to access your
	// AWS account.
	//
	// Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy
	// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy)
	// managed policy to this role. For more information see Attaching and Detaching
	// IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html).
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateDRTRoleInput) String added in v0.5.0 

func (s AssociateDRTRoleInput) String() string

String returns the string representation

func (*AssociateDRTRoleInput) Validate added in v0.5.0 

func (s *AssociateDRTRoleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateDRTRoleOutput added in v0.5.0 

type AssociateDRTRoleOutput struct {
	// contains filtered or unexported fields
}

func (AssociateDRTRoleOutput) String added in v0.5.0 

func (s AssociateDRTRoleOutput) String() string

String returns the string representation

type AssociateDRTRoleRequest added in v0.5.0 

type AssociateDRTRoleRequest struct {
	*aws.Request
	Input *AssociateDRTRoleInput
	Copy  func(*AssociateDRTRoleInput) AssociateDRTRoleRequest
}

AssociateDRTRoleRequest is the request type for the AssociateDRTRole API operation.

func (AssociateDRTRoleRequest) Send added in v0.5.0 

func (r AssociateDRTRoleRequest) Send(ctx context.Context) (*AssociateDRTRoleResponse, error)

Send marshals and sends the AssociateDRTRole API request.

type AssociateDRTRoleResponse added in v0.9.0 

type AssociateDRTRoleResponse struct {
	*AssociateDRTRoleOutput
	// contains filtered or unexported fields
}

AssociateDRTRoleResponse is the response type for the AssociateDRTRole API operation.

func (*AssociateDRTRoleResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateDRTRoleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateDRTRole request.

type AttackDetail 

type AttackDetail struct {

	// List of counters that describe the attack for the specified time period.
	AttackCounters []SummarizedCounter `type:"list"`

	// The unique identifier (ID) of the attack.
	AttackId *string `min:"1" type:"string"`

	// The array of AttackProperty objects.
	AttackProperties []AttackProperty `type:"list"`

	// The time the attack ended, in Unix time in seconds. For more information
	// see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	EndTime *time.Time `type:"timestamp"`

	// List of mitigation actions taken for the attack.
	Mitigations []Mitigation `type:"list"`

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string `min:"1" type:"string"`

	// The time the attack started, in Unix time in seconds. For more information
	// see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time `type:"timestamp"`

	// If applicable, additional detail about the resource being attacked, for example,
	// IP address or URL.
	SubResources []SubResourceSummary `type:"list"`
	// contains filtered or unexported fields
}

The details of a DDoS attack.

func (AttackDetail) String 

func (s AttackDetail) String() string

String returns the string representation

type AttackLayer added in v0.2.0 

type AttackLayer string
const (
	AttackLayerNetwork     AttackLayer = "NETWORK"
	AttackLayerApplication AttackLayer = "APPLICATION"
)

Enum values for AttackLayer

func (AttackLayer) MarshalValue added in v0.3.0 

func (enum AttackLayer) MarshalValue() (string, error)

func (AttackLayer) MarshalValueBuf added in v0.3.0 

func (enum AttackLayer) MarshalValueBuf(b []byte) ([]byte, error)

type AttackProperty added in v0.2.0 

type AttackProperty struct {

	// The type of distributed denial of service (DDoS) event that was observed.
	// NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer
	// 7 events.
	AttackLayer AttackLayer `type:"string" enum:"true"`

	// Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR
	// and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective
	// pingback DDoS attacks.
	AttackPropertyIdentifier AttackPropertyIdentifier `type:"string" enum:"true"`

	// The array of Contributor objects that includes the top five contributors
	// to an attack.
	TopContributors []Contributor `type:"list"`

	// The total contributions made to this attack by all contributors, not just
	// the five listed in the TopContributors list.
	Total *int64 `type:"long"`

	// The unit of the Value of the contributions.
	Unit Unit `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of the described attack.

func (AttackProperty) String added in v0.2.0 

func (s AttackProperty) String() string

String returns the string representation

type AttackPropertyIdentifier added in v0.2.0 

type AttackPropertyIdentifier string
const (
	AttackPropertyIdentifierDestinationUrl             AttackPropertyIdentifier = "DESTINATION_URL"
	AttackPropertyIdentifierReferrer                   AttackPropertyIdentifier = "REFERRER"
	AttackPropertyIdentifierSourceAsn                  AttackPropertyIdentifier = "SOURCE_ASN"
	AttackPropertyIdentifierSourceCountry              AttackPropertyIdentifier = "SOURCE_COUNTRY"
	AttackPropertyIdentifierSourceIpAddress            AttackPropertyIdentifier = "SOURCE_IP_ADDRESS"
	AttackPropertyIdentifierSourceUserAgent            AttackPropertyIdentifier = "SOURCE_USER_AGENT"
	AttackPropertyIdentifierWordpressPingbackReflector AttackPropertyIdentifier = "WORDPRESS_PINGBACK_REFLECTOR"
	AttackPropertyIdentifierWordpressPingbackSource    AttackPropertyIdentifier = "WORDPRESS_PINGBACK_SOURCE"
)

Enum values for AttackPropertyIdentifier

func (AttackPropertyIdentifier) MarshalValue added in v0.3.0 

func (enum AttackPropertyIdentifier) MarshalValue() (string, error)

func (AttackPropertyIdentifier) MarshalValueBuf added in v0.3.0 

func (enum AttackPropertyIdentifier) MarshalValueBuf(b []byte) ([]byte, error)

type AttackSummary 

type AttackSummary struct {

	// The unique identifier (ID) of the attack.
	AttackId *string `type:"string"`

	// The list of attacks for a specified time period.
	AttackVectors []AttackVectorDescription `type:"list"`

	// The end time of the attack, in Unix time in seconds. For more information
	// see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	EndTime *time.Time `type:"timestamp"`

	// The ARN (Amazon Resource Name) of the resource that was attacked.
	ResourceArn *string `type:"string"`

	// The start time of the attack, in Unix time in seconds. For more information
	// see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summarizes all DDoS attacks for a specified time period.

func (AttackSummary) String 

func (s AttackSummary) String() string

String returns the string representation

type AttackVectorDescription 

type AttackVectorDescription struct {

	// The attack type. Valid values:
	//
	//    * UDP_TRAFFIC
	//
	//    * UDP_FRAGMENT
	//
	//    * GENERIC_UDP_REFLECTION
	//
	//    * DNS_REFLECTION
	//
	//    * NTP_REFLECTION
	//
	//    * CHARGEN_REFLECTION
	//
	//    * SSDP_REFLECTION
	//
	//    * PORT_MAPPER
	//
	//    * RIP_REFLECTION
	//
	//    * SNMP_REFLECTION
	//
	//    * MSSQL_REFLECTION
	//
	//    * NET_BIOS_REFLECTION
	//
	//    * SYN_FLOOD
	//
	//    * ACK_FLOOD
	//
	//    * REQUEST_FLOOD
	//
	//    * HTTP_REFLECTION
	//
	//    * UDS_REFLECTION
	//
	//    * MEMCACHED_REFLECTION
	//
	// VectorType is a required field
	VectorType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the attack.

func (AttackVectorDescription) String 

func (s AttackVectorDescription) String() string

String returns the string representation

type AutoRenew added in v0.5.0 

type AutoRenew string
const (
	AutoRenewEnabled  AutoRenew = "ENABLED"
	AutoRenewDisabled AutoRenew = "DISABLED"
)

Enum values for AutoRenew

func (AutoRenew) MarshalValue added in v0.5.0 

func (enum AutoRenew) MarshalValue() (string, error)

func (AutoRenew) MarshalValueBuf added in v0.5.0 

func (enum AutoRenew) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS Shield. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := shield.New(myConfig)

func (*Client) AssociateDRTLogBucketRequest added in v0.9.0 

func (c *Client) AssociateDRTLogBucketRequest(input *AssociateDRTLogBucketInput) AssociateDRTLogBucketRequest

AssociateDRTLogBucketRequest returns a request value for making API operation for AWS Shield.

Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 

// Example sending a request using AssociateDRTLogBucketRequest.
req := client.AssociateDRTLogBucketRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTLogBucket

func (*Client) AssociateDRTRoleRequest added in v0.9.0 

func (c *Client) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) AssociateDRTRoleRequest

AssociateDRTRoleRequest returns a request value for making API operation for AWS Shield.

Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 

// Example sending a request using AssociateDRTRoleRequest.
req := client.AssociateDRTRoleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateDRTRole

func (*Client) CreateProtectionRequest added in v0.9.0 

func (c *Client) CreateProtectionRequest(input *CreateProtectionInput) CreateProtectionRequest

CreateProtectionRequest returns a request value for making API operation for AWS Shield.

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console (https://console.aws.amazon.com/waf/). For more information see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html). 

// Example sending a request using CreateProtectionRequest.
req := client.CreateProtectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtection

func (*Client) CreateSubscriptionRequest added in v0.9.0 

func (c *Client) CreateSubscriptionRequest(input *CreateSubscriptionInput) CreateSubscriptionRequest

CreateSubscriptionRequest returns a request value for making API operation for AWS Shield.

Activates AWS Shield Advanced for an account.

As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf (https://docs.aws.amazon.com/waf/latest/developerguide/authorize-DRT.html).

To use the services of the DRT, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. 

// Example sending a request using CreateSubscriptionRequest.
req := client.CreateSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscription

func (*Client) DeleteProtectionRequest added in v0.9.0 

func (c *Client) DeleteProtectionRequest(input *DeleteProtectionInput) DeleteProtectionRequest

DeleteProtectionRequest returns a request value for making API operation for AWS Shield.

Deletes an AWS Shield Advanced Protection. 

// Example sending a request using DeleteProtectionRequest.
req := client.DeleteProtectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtection

func (*Client) DeleteSubscriptionRequest added in v0.9.0 

func (c *Client) DeleteSubscriptionRequest(input *DeleteSubscriptionInput) DeleteSubscriptionRequest

DeleteSubscriptionRequest returns a request value for making API operation for AWS Shield.

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment. 

// Example sending a request using DeleteSubscriptionRequest.
req := client.DeleteSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscription

func (*Client) DescribeAttackRequest added in v0.9.0 

func (c *Client) DescribeAttackRequest(input *DescribeAttackInput) DescribeAttackRequest

DescribeAttackRequest returns a request value for making API operation for AWS Shield.

Describes the details of a DDoS attack. 

// Example sending a request using DescribeAttackRequest.
req := client.DescribeAttackRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttack

func (*Client) DescribeDRTAccessRequest added in v0.9.0 

func (c *Client) DescribeDRTAccessRequest(input *DescribeDRTAccessInput) DescribeDRTAccessRequest

DescribeDRTAccessRequest returns a request value for making API operation for AWS Shield.

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation. 

// Example sending a request using DescribeDRTAccessRequest.
req := client.DescribeDRTAccessRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeDRTAccess

func (*Client) DescribeEmergencyContactSettingsRequest added in v0.9.0 

func (c *Client) DescribeEmergencyContactSettingsRequest(input *DescribeEmergencyContactSettingsInput) DescribeEmergencyContactSettingsRequest

DescribeEmergencyContactSettingsRequest returns a request value for making API operation for AWS Shield.

Lists the email addresses that the DRT can use to contact you during a suspected attack. 

// Example sending a request using DescribeEmergencyContactSettingsRequest.
req := client.DescribeEmergencyContactSettingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeEmergencyContactSettings

func (*Client) DescribeProtectionRequest added in v0.9.0 

func (c *Client) DescribeProtectionRequest(input *DescribeProtectionInput) DescribeProtectionRequest

DescribeProtectionRequest returns a request value for making API operation for AWS Shield.

Lists the details of a Protection object. 

// Example sending a request using DescribeProtectionRequest.
req := client.DescribeProtectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtection

func (*Client) DescribeSubscriptionRequest added in v0.9.0 

func (c *Client) DescribeSubscriptionRequest(input *DescribeSubscriptionInput) DescribeSubscriptionRequest

DescribeSubscriptionRequest returns a request value for making API operation for AWS Shield.

Provides details about the AWS Shield Advanced subscription for an account. 

// Example sending a request using DescribeSubscriptionRequest.
req := client.DescribeSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscription

func (*Client) DisassociateDRTLogBucketRequest added in v0.9.0 

func (c *Client) DisassociateDRTLogBucketRequest(input *DisassociateDRTLogBucketInput) DisassociateDRTLogBucketRequest

DisassociateDRTLogBucketRequest returns a request value for making API operation for AWS Shield.

Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access. 

// Example sending a request using DisassociateDRTLogBucketRequest.
req := client.DisassociateDRTLogBucketRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTLogBucket

func (*Client) DisassociateDRTRoleRequest added in v0.9.0 

func (c *Client) DisassociateDRTRoleRequest(input *DisassociateDRTRoleInput) DisassociateDRTRoleRequest

DisassociateDRTRoleRequest returns a request value for making API operation for AWS Shield.

Removes the DDoS Response team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access. 

// Example sending a request using DisassociateDRTRoleRequest.
req := client.DisassociateDRTRoleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisassociateDRTRole

func (*Client) GetSubscriptionStateRequest added in v0.9.0 

func (c *Client) GetSubscriptionStateRequest(input *GetSubscriptionStateInput) GetSubscriptionStateRequest

GetSubscriptionStateRequest returns a request value for making API operation for AWS Shield.

Returns the SubscriptionState, either Active or Inactive. 

// Example sending a request using GetSubscriptionStateRequest.
req := client.GetSubscriptionStateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/GetSubscriptionState

func (*Client) ListAttacksRequest added in v0.9.0 

func (c *Client) ListAttacksRequest(input *ListAttacksInput) ListAttacksRequest

ListAttacksRequest returns a request value for making API operation for AWS Shield.

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period. 

// Example sending a request using ListAttacksRequest.
req := client.ListAttacksRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacks

func (*Client) ListProtectionsRequest added in v0.9.0 

func (c *Client) ListProtectionsRequest(input *ListProtectionsInput) ListProtectionsRequest

ListProtectionsRequest returns a request value for making API operation for AWS Shield.

Lists all Protection objects for the account. 

// Example sending a request using ListProtectionsRequest.
req := client.ListProtectionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections

func (*Client) UpdateEmergencyContactSettingsRequest added in v0.9.0 

func (c *Client) UpdateEmergencyContactSettingsRequest(input *UpdateEmergencyContactSettingsInput) UpdateEmergencyContactSettingsRequest

UpdateEmergencyContactSettingsRequest returns a request value for making API operation for AWS Shield.

Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack. 

// Example sending a request using UpdateEmergencyContactSettingsRequest.
req := client.UpdateEmergencyContactSettingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateEmergencyContactSettings

func (*Client) UpdateSubscriptionRequest added in v0.9.0 

func (c *Client) UpdateSubscriptionRequest(input *UpdateSubscriptionInput) UpdateSubscriptionRequest

UpdateSubscriptionRequest returns a request value for making API operation for AWS Shield.

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. 

// Example sending a request using UpdateSubscriptionRequest.
req := client.UpdateSubscriptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateSubscription

type Contributor added in v0.2.0 

type Contributor struct {

	// The name of the contributor. This is dependent on the AttackPropertyIdentifier.
	// For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name
	// could be United States.
	Name *string `type:"string"`

	// The contribution of this contributor expressed in Protection units. For example
	// 10,000.
	Value *int64 `type:"long"`
	// contains filtered or unexported fields
}

A contributor to the attack and their contribution.

func (Contributor) String added in v0.2.0 

func (s Contributor) String() string

String returns the string representation

type CreateProtectionInput 

type CreateProtectionInput struct {

	// Friendly name for the Protection you are creating.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The ARN (Amazon Resource Name) of the resource to be protected.
	//
	// The ARN should be in one of the following formats:
	//
	//    * For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
	//
	//    * For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
	//
	//    * For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
	//
	//    * For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
	//
	//    * For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
	//
	//    * For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProtectionInput) String 

func (s CreateProtectionInput) String() string

String returns the string representation

func (*CreateProtectionInput) Validate 

func (s *CreateProtectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProtectionOutput 

type CreateProtectionOutput struct {

	// The unique identifier (ID) for the Protection object that is created.
	ProtectionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateProtectionOutput) String 

func (s CreateProtectionOutput) String() string

String returns the string representation

type CreateProtectionRequest 

type CreateProtectionRequest struct {
	*aws.Request
	Input *CreateProtectionInput
	Copy  func(*CreateProtectionInput) CreateProtectionRequest
}

CreateProtectionRequest is the request type for the CreateProtection API operation.

func (CreateProtectionRequest) Send 

func (r CreateProtectionRequest) Send(ctx context.Context) (*CreateProtectionResponse, error)

Send marshals and sends the CreateProtection API request.

type CreateProtectionResponse added in v0.9.0 

type CreateProtectionResponse struct {
	*CreateProtectionOutput
	// contains filtered or unexported fields
}

CreateProtectionResponse is the response type for the CreateProtection API operation.

func (*CreateProtectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateProtectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProtection request.

type CreateSubscriptionInput 

type CreateSubscriptionInput struct {
	// contains filtered or unexported fields
}

func (CreateSubscriptionInput) String 

func (s CreateSubscriptionInput) String() string

String returns the string representation

type CreateSubscriptionOutput 

type CreateSubscriptionOutput struct {
	// contains filtered or unexported fields
}

func (CreateSubscriptionOutput) String 

func (s CreateSubscriptionOutput) String() string

String returns the string representation

type CreateSubscriptionRequest 

type CreateSubscriptionRequest struct {
	*aws.Request
	Input *CreateSubscriptionInput
	Copy  func(*CreateSubscriptionInput) CreateSubscriptionRequest
}

CreateSubscriptionRequest is the request type for the CreateSubscription API operation.

func (CreateSubscriptionRequest) Send 

func (r CreateSubscriptionRequest) Send(ctx context.Context) (*CreateSubscriptionResponse, error)

Send marshals and sends the CreateSubscription API request.

type CreateSubscriptionResponse added in v0.9.0 

type CreateSubscriptionResponse struct {
	*CreateSubscriptionOutput
	// contains filtered or unexported fields
}

CreateSubscriptionResponse is the response type for the CreateSubscription API operation.

func (*CreateSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSubscription request.

type DeleteProtectionInput 

type DeleteProtectionInput struct {

	// The unique identifier (ID) for the Protection object to be deleted.
	//
	// ProtectionId is a required field
	ProtectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProtectionInput) String 

func (s DeleteProtectionInput) String() string

String returns the string representation

func (*DeleteProtectionInput) Validate 

func (s *DeleteProtectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProtectionOutput 

type DeleteProtectionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteProtectionOutput) String 

func (s DeleteProtectionOutput) String() string

String returns the string representation

type DeleteProtectionRequest 

type DeleteProtectionRequest struct {
	*aws.Request
	Input *DeleteProtectionInput
	Copy  func(*DeleteProtectionInput) DeleteProtectionRequest
}

DeleteProtectionRequest is the request type for the DeleteProtection API operation.

func (DeleteProtectionRequest) Send 

func (r DeleteProtectionRequest) Send(ctx context.Context) (*DeleteProtectionResponse, error)

Send marshals and sends the DeleteProtection API request.

type DeleteProtectionResponse added in v0.9.0 

type DeleteProtectionResponse struct {
	*DeleteProtectionOutput
	// contains filtered or unexported fields
}

DeleteProtectionResponse is the response type for the DeleteProtection API operation.

func (*DeleteProtectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteProtectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProtection request.

type DeleteSubscriptionInput 

type DeleteSubscriptionInput struct {
	// contains filtered or unexported fields
}

func (DeleteSubscriptionInput) String 

func (s DeleteSubscriptionInput) String() string

String returns the string representation

type DeleteSubscriptionOutput 

type DeleteSubscriptionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSubscriptionOutput) String 

func (s DeleteSubscriptionOutput) String() string

String returns the string representation

type DeleteSubscriptionRequest 

type DeleteSubscriptionRequest struct {
	*aws.Request
	Input *DeleteSubscriptionInput
	Copy  func(*DeleteSubscriptionInput) DeleteSubscriptionRequest
}

DeleteSubscriptionRequest is the request type for the DeleteSubscription API operation.

func (DeleteSubscriptionRequest) Send 

func (r DeleteSubscriptionRequest) Send(ctx context.Context) (*DeleteSubscriptionResponse, error)

Send marshals and sends the DeleteSubscription API request.

type DeleteSubscriptionResponse added in v0.9.0 

type DeleteSubscriptionResponse struct {
	*DeleteSubscriptionOutput
	// contains filtered or unexported fields
}

DeleteSubscriptionResponse is the response type for the DeleteSubscription API operation.

func (*DeleteSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSubscription request.

type DescribeAttackInput 

type DescribeAttackInput struct {

	// The unique identifier (ID) for the attack that to be described.
	//
	// AttackId is a required field
	AttackId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAttackInput) String 

func (s DescribeAttackInput) String() string

String returns the string representation

func (*DescribeAttackInput) Validate 

func (s *DescribeAttackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAttackOutput 

type DescribeAttackOutput struct {

	// The attack that is described.
	Attack *AttackDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAttackOutput) String 

func (s DescribeAttackOutput) String() string

String returns the string representation

type DescribeAttackRequest 

type DescribeAttackRequest struct {
	*aws.Request
	Input *DescribeAttackInput
	Copy  func(*DescribeAttackInput) DescribeAttackRequest
}

DescribeAttackRequest is the request type for the DescribeAttack API operation.

func (DescribeAttackRequest) Send 

func (r DescribeAttackRequest) Send(ctx context.Context) (*DescribeAttackResponse, error)

Send marshals and sends the DescribeAttack API request.

type DescribeAttackResponse added in v0.9.0 

type DescribeAttackResponse struct {
	*DescribeAttackOutput
	// contains filtered or unexported fields
}

DescribeAttackResponse is the response type for the DescribeAttack API operation.

func (*DescribeAttackResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAttackResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAttack request.

type DescribeDRTAccessInput added in v0.5.0 

type DescribeDRTAccessInput struct {
	// contains filtered or unexported fields
}

func (DescribeDRTAccessInput) String added in v0.5.0 

func (s DescribeDRTAccessInput) String() string

String returns the string representation

type DescribeDRTAccessOutput added in v0.5.0 

type DescribeDRTAccessOutput struct {

	// The list of Amazon S3 buckets accessed by the DRT.
	LogBucketList []string `type:"list"`

	// The Amazon Resource Name (ARN) of the role the DRT used to access your AWS
	// account.
	RoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDRTAccessOutput) String added in v0.5.0 

func (s DescribeDRTAccessOutput) String() string

String returns the string representation

type DescribeDRTAccessRequest added in v0.5.0 

type DescribeDRTAccessRequest struct {
	*aws.Request
	Input *DescribeDRTAccessInput
	Copy  func(*DescribeDRTAccessInput) DescribeDRTAccessRequest
}

DescribeDRTAccessRequest is the request type for the DescribeDRTAccess API operation.

func (DescribeDRTAccessRequest) Send added in v0.5.0 

func (r DescribeDRTAccessRequest) Send(ctx context.Context) (*DescribeDRTAccessResponse, error)

Send marshals and sends the DescribeDRTAccess API request.

type DescribeDRTAccessResponse added in v0.9.0 

type DescribeDRTAccessResponse struct {
	*DescribeDRTAccessOutput
	// contains filtered or unexported fields
}

DescribeDRTAccessResponse is the response type for the DescribeDRTAccess API operation.

func (*DescribeDRTAccessResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDRTAccessResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDRTAccess request.

type DescribeEmergencyContactSettingsInput added in v0.5.0 

type DescribeEmergencyContactSettingsInput struct {
	// contains filtered or unexported fields
}

func (DescribeEmergencyContactSettingsInput) String added in v0.5.0 

func (s DescribeEmergencyContactSettingsInput) String() string

String returns the string representation

type DescribeEmergencyContactSettingsOutput added in v0.5.0 

type DescribeEmergencyContactSettingsOutput struct {

	// A list of email addresses that the DRT can use to contact you during a suspected
	// attack.
	EmergencyContactList []EmergencyContact `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeEmergencyContactSettingsOutput) String added in v0.5.0 

func (s DescribeEmergencyContactSettingsOutput) String() string

String returns the string representation

type DescribeEmergencyContactSettingsRequest added in v0.5.0 

type DescribeEmergencyContactSettingsRequest struct {
	*aws.Request
	Input *DescribeEmergencyContactSettingsInput
	Copy  func(*DescribeEmergencyContactSettingsInput) DescribeEmergencyContactSettingsRequest
}

DescribeEmergencyContactSettingsRequest is the request type for the DescribeEmergencyContactSettings API operation.

func (DescribeEmergencyContactSettingsRequest) Send added in v0.5.0 

func (r DescribeEmergencyContactSettingsRequest) Send(ctx context.Context) (*DescribeEmergencyContactSettingsResponse, error)

Send marshals and sends the DescribeEmergencyContactSettings API request.

type DescribeEmergencyContactSettingsResponse added in v0.9.0 

type DescribeEmergencyContactSettingsResponse struct {
	*DescribeEmergencyContactSettingsOutput
	// contains filtered or unexported fields
}

DescribeEmergencyContactSettingsResponse is the response type for the DescribeEmergencyContactSettings API operation.

func (*DescribeEmergencyContactSettingsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEmergencyContactSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEmergencyContactSettings request.

type DescribeProtectionInput 

type DescribeProtectionInput struct {

	// The unique identifier (ID) for the Protection object that is described. When
	// submitting the DescribeProtection request you must provide either the ResourceArn
	// or the ProtectionID, but not both.
	ProtectionId *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the AWS resource for the Protection object
	// that is described. When submitting the DescribeProtection request you must
	// provide either the ResourceArn or the ProtectionID, but not both.
	ResourceArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProtectionInput) String 

func (s DescribeProtectionInput) String() string

String returns the string representation

func (*DescribeProtectionInput) Validate 

func (s *DescribeProtectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProtectionOutput 

type DescribeProtectionOutput struct {

	// The Protection object that is described.
	Protection *Protection `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeProtectionOutput) String 

func (s DescribeProtectionOutput) String() string

String returns the string representation

type DescribeProtectionRequest 

type DescribeProtectionRequest struct {
	*aws.Request
	Input *DescribeProtectionInput
	Copy  func(*DescribeProtectionInput) DescribeProtectionRequest
}

DescribeProtectionRequest is the request type for the DescribeProtection API operation.

func (DescribeProtectionRequest) Send 

func (r DescribeProtectionRequest) Send(ctx context.Context) (*DescribeProtectionResponse, error)

Send marshals and sends the DescribeProtection API request.

type DescribeProtectionResponse added in v0.9.0 

type DescribeProtectionResponse struct {
	*DescribeProtectionOutput
	// contains filtered or unexported fields
}

DescribeProtectionResponse is the response type for the DescribeProtection API operation.

func (*DescribeProtectionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeProtectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProtection request.

type DescribeSubscriptionInput 

type DescribeSubscriptionInput struct {
	// contains filtered or unexported fields
}

func (DescribeSubscriptionInput) String 

func (s DescribeSubscriptionInput) String() string

String returns the string representation

type DescribeSubscriptionOutput 

type DescribeSubscriptionOutput struct {

	// The AWS Shield Advanced subscription details for an account.
	Subscription *Subscription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSubscriptionOutput) String 

func (s DescribeSubscriptionOutput) String() string

String returns the string representation

type DescribeSubscriptionRequest 

type DescribeSubscriptionRequest struct {
	*aws.Request
	Input *DescribeSubscriptionInput
	Copy  func(*DescribeSubscriptionInput) DescribeSubscriptionRequest
}

DescribeSubscriptionRequest is the request type for the DescribeSubscription API operation.

func (DescribeSubscriptionRequest) Send 

func (r DescribeSubscriptionRequest) Send(ctx context.Context) (*DescribeSubscriptionResponse, error)

Send marshals and sends the DescribeSubscription API request.

type DescribeSubscriptionResponse added in v0.9.0 

type DescribeSubscriptionResponse struct {
	*DescribeSubscriptionOutput
	// contains filtered or unexported fields
}

DescribeSubscriptionResponse is the response type for the DescribeSubscription API operation.

func (*DescribeSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSubscription request.

type DisassociateDRTLogBucketInput added in v0.5.0 

type DisassociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// LogBucket is a required field
	LogBucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateDRTLogBucketInput) String added in v0.5.0 

func (s DisassociateDRTLogBucketInput) String() string

String returns the string representation

func (*DisassociateDRTLogBucketInput) Validate added in v0.5.0 

func (s *DisassociateDRTLogBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateDRTLogBucketOutput added in v0.5.0 

type DisassociateDRTLogBucketOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateDRTLogBucketOutput) String added in v0.5.0 

func (s DisassociateDRTLogBucketOutput) String() string

String returns the string representation

type DisassociateDRTLogBucketRequest added in v0.5.0 

type DisassociateDRTLogBucketRequest struct {
	*aws.Request
	Input *DisassociateDRTLogBucketInput
	Copy  func(*DisassociateDRTLogBucketInput) DisassociateDRTLogBucketRequest
}

DisassociateDRTLogBucketRequest is the request type for the DisassociateDRTLogBucket API operation.

func (DisassociateDRTLogBucketRequest) Send added in v0.5.0 

func (r DisassociateDRTLogBucketRequest) Send(ctx context.Context) (*DisassociateDRTLogBucketResponse, error)

Send marshals and sends the DisassociateDRTLogBucket API request.

type DisassociateDRTLogBucketResponse added in v0.9.0 

type DisassociateDRTLogBucketResponse struct {
	*DisassociateDRTLogBucketOutput
	// contains filtered or unexported fields
}

DisassociateDRTLogBucketResponse is the response type for the DisassociateDRTLogBucket API operation.

func (*DisassociateDRTLogBucketResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateDRTLogBucketResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateDRTLogBucket request.

type DisassociateDRTRoleInput added in v0.5.0 

type DisassociateDRTRoleInput struct {
	// contains filtered or unexported fields
}

func (DisassociateDRTRoleInput) String added in v0.5.0 

func (s DisassociateDRTRoleInput) String() string

String returns the string representation

type DisassociateDRTRoleOutput added in v0.5.0 

type DisassociateDRTRoleOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateDRTRoleOutput) String added in v0.5.0 

func (s DisassociateDRTRoleOutput) String() string

String returns the string representation

type DisassociateDRTRoleRequest added in v0.5.0 

type DisassociateDRTRoleRequest struct {
	*aws.Request
	Input *DisassociateDRTRoleInput
	Copy  func(*DisassociateDRTRoleInput) DisassociateDRTRoleRequest
}

DisassociateDRTRoleRequest is the request type for the DisassociateDRTRole API operation.

func (DisassociateDRTRoleRequest) Send added in v0.5.0 

func (r DisassociateDRTRoleRequest) Send(ctx context.Context) (*DisassociateDRTRoleResponse, error)

Send marshals and sends the DisassociateDRTRole API request.

type DisassociateDRTRoleResponse added in v0.9.0 

type DisassociateDRTRoleResponse struct {
	*DisassociateDRTRoleOutput
	// contains filtered or unexported fields
}

DisassociateDRTRoleResponse is the response type for the DisassociateDRTRole API operation.

func (*DisassociateDRTRoleResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateDRTRoleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateDRTRole request.

type EmergencyContact added in v0.5.0 

type EmergencyContact struct {

	// An email address that the DRT can use to contact you during a suspected attack.
	//
	// EmailAddress is a required field
	EmailAddress *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contact information that the DRT can use to contact you during a suspected attack.

func (EmergencyContact) String added in v0.5.0 

func (s EmergencyContact) String() string

String returns the string representation

func (*EmergencyContact) Validate added in v0.5.0 

func (s *EmergencyContact) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSubscriptionStateInput added in v0.2.0 

type GetSubscriptionStateInput struct {
	// contains filtered or unexported fields
}

func (GetSubscriptionStateInput) String added in v0.2.0 

func (s GetSubscriptionStateInput) String() string

String returns the string representation

type GetSubscriptionStateOutput added in v0.2.0 

type GetSubscriptionStateOutput struct {

	// The status of the subscription.
	//
	// SubscriptionState is a required field
	SubscriptionState SubscriptionState `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (GetSubscriptionStateOutput) String added in v0.2.0 

func (s GetSubscriptionStateOutput) String() string

String returns the string representation

type GetSubscriptionStateRequest added in v0.2.0 

type GetSubscriptionStateRequest struct {
	*aws.Request
	Input *GetSubscriptionStateInput
	Copy  func(*GetSubscriptionStateInput) GetSubscriptionStateRequest
}

GetSubscriptionStateRequest is the request type for the GetSubscriptionState API operation.

func (GetSubscriptionStateRequest) Send added in v0.2.0 

func (r GetSubscriptionStateRequest) Send(ctx context.Context) (*GetSubscriptionStateResponse, error)

Send marshals and sends the GetSubscriptionState API request.

type GetSubscriptionStateResponse added in v0.9.0 

type GetSubscriptionStateResponse struct {
	*GetSubscriptionStateOutput
	// contains filtered or unexported fields
}

GetSubscriptionStateResponse is the response type for the GetSubscriptionState API operation.

func (*GetSubscriptionStateResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetSubscriptionStateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSubscriptionState request.

type Limit added in v0.5.0 

type Limit struct {

	// The maximum number of protections that can be created for the specified Type.
	Max *int64 `type:"long"`

	// The type of protection.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies how many protections of a given type you can create.

func (Limit) String added in v0.5.0 

func (s Limit) String() string

String returns the string representation

type ListAttacksInput 

type ListAttacksInput struct {

	// The end of the time period for the attacks. This is a timestamp type. The
	// sample request above indicates a number type because the default used by
	// WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	EndTime *TimeRange `type:"structure"`

	// The maximum number of AttackSummary objects to be returned. If this is left
	// blank, the first 20 results will be returned.
	//
	// This is a maximum value; it is possible that AWS WAF will return the results
	// in smaller batches. That is, the number of AttackSummary objects returned
	// could be less than MaxResults, even if there are still more AttackSummary
	// objects yet to return. If there are more AttackSummary objects to return,
	// AWS WAF will always also return a NextToken.
	MaxResults *int64 `type:"integer"`

	// The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest.
	// Pass null if this is the first call.
	NextToken *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the resource that was attacked. If this
	// is left blank, all applicable resources for this account will be included.
	ResourceArns []string `type:"list"`

	// The start of the time period for the attacks. This is a timestamp type. The
	// sample request above indicates a number type because the default used by
	// WAF is Unix time in seconds. However any valid timestamp format (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	StartTime *TimeRange `type:"structure"`
	// contains filtered or unexported fields
}

func (ListAttacksInput) String 

func (s ListAttacksInput) String() string

String returns the string representation

func (*ListAttacksInput) Validate 

func (s *ListAttacksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttacksOutput 

type ListAttacksOutput struct {

	// The attack information for the specified time range.
	AttackSummaries []AttackSummary `type:"list"`

	// The token returned by a previous call to indicate that there is more data
	// available. If not null, more results are available. Pass this value for the
	// NextMarker parameter in a subsequent call to ListAttacks to retrieve the
	// next set of items.
	//
	// AWS WAF might return the list of AttackSummary objects in batches smaller
	// than the number specified by MaxResults. If there are more AttackSummary
	// objects to return, AWS WAF will always also return a NextToken.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAttacksOutput) String 

func (s ListAttacksOutput) String() string

String returns the string representation

type ListAttacksRequest 

type ListAttacksRequest struct {
	*aws.Request
	Input *ListAttacksInput
	Copy  func(*ListAttacksInput) ListAttacksRequest
}

ListAttacksRequest is the request type for the ListAttacks API operation.

func (ListAttacksRequest) Send 

func (r ListAttacksRequest) Send(ctx context.Context) (*ListAttacksResponse, error)

Send marshals and sends the ListAttacks API request.

type ListAttacksResponse added in v0.9.0 

type ListAttacksResponse struct {
	*ListAttacksOutput
	// contains filtered or unexported fields
}

ListAttacksResponse is the response type for the ListAttacks API operation.

func (*ListAttacksResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListAttacksResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAttacks request.

type ListProtectionsInput 

type ListProtectionsInput struct {

	// The maximum number of Protection objects to be returned. If this is left
	// blank the first 20 results will be returned.
	//
	// This is a maximum value; it is possible that AWS WAF will return the results
	// in smaller batches. That is, the number of Protection objects returned could
	// be less than MaxResults, even if there are still more Protection objects
	// yet to return. If there are more Protection objects to return, AWS WAF will
	// always also return a NextToken.
	MaxResults *int64 `type:"integer"`

	// The ListProtectionsRequest.NextToken value from a previous call to ListProtections.
	// Pass null if this is the first call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListProtectionsInput) String 

func (s ListProtectionsInput) String() string

String returns the string representation

func (*ListProtectionsInput) Validate 

func (s *ListProtectionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProtectionsOutput 

type ListProtectionsOutput struct {

	// If you specify a value for MaxResults and you have more Protections than
	// the value of MaxResults, AWS Shield Advanced returns a NextToken value in
	// the response that allows you to list another group of Protections. For the
	// second and subsequent ListProtections requests, specify the value of NextToken
	// from the previous response to get information about another batch of Protections.
	//
	// AWS WAF might return the list of Protection objects in batches smaller than
	// the number specified by MaxResults. If there are more Protection objects
	// to return, AWS WAF will always also return a NextToken.
	NextToken *string `min:"1" type:"string"`

	// The array of enabled Protection objects.
	Protections []Protection `type:"list"`
	// contains filtered or unexported fields
}

func (ListProtectionsOutput) String 

func (s ListProtectionsOutput) String() string

String returns the string representation

type ListProtectionsRequest 

type ListProtectionsRequest struct {
	*aws.Request
	Input *ListProtectionsInput
	Copy  func(*ListProtectionsInput) ListProtectionsRequest
}

ListProtectionsRequest is the request type for the ListProtections API operation.

func (ListProtectionsRequest) Send 

func (r ListProtectionsRequest) Send(ctx context.Context) (*ListProtectionsResponse, error)

Send marshals and sends the ListProtections API request.

type ListProtectionsResponse added in v0.9.0 

type ListProtectionsResponse struct {
	*ListProtectionsOutput
	// contains filtered or unexported fields
}

ListProtectionsResponse is the response type for the ListProtections API operation.

func (*ListProtectionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListProtectionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProtections request.

type Mitigation 

type Mitigation struct {

	// The name of the mitigation taken for this attack.
	MitigationName *string `type:"string"`
	// contains filtered or unexported fields
}

The mitigation applied to a DDoS attack.

func (Mitigation) String 

func (s Mitigation) String() string

String returns the string representation

type Protection 

type Protection struct {

	// The unique identifier (ID) of the protection.
	Id *string `min:"1" type:"string"`

	// The friendly name of the protection. For example, My CloudFront distributions.
	Name *string `min:"1" type:"string"`

	// The ARN (Amazon Resource Name) of the AWS resource that is protected.
	ResourceArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that represents a resource that is under DDoS protection.

func (Protection) String 

func (s Protection) String() string

String returns the string representation

type SubResourceSummary 

type SubResourceSummary struct {

	// The list of attack types and associated counters.
	AttackVectors []SummarizedAttackVector `type:"list"`

	// The counters that describe the details of the attack.
	Counters []SummarizedCounter `type:"list"`

	// The unique identifier (ID) of the SubResource.
	Id *string `type:"string"`

	// The SubResource type.
	Type SubResourceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The attack information for the specified SubResource.

func (SubResourceSummary) String 

func (s SubResourceSummary) String() string

String returns the string representation

type SubResourceType 

type SubResourceType string
const (
	SubResourceTypeIp  SubResourceType = "IP"
	SubResourceTypeUrl SubResourceType = "URL"
)

Enum values for SubResourceType

func (SubResourceType) MarshalValue added in v0.3.0 

func (enum SubResourceType) MarshalValue() (string, error)

func (SubResourceType) MarshalValueBuf added in v0.3.0 

func (enum SubResourceType) MarshalValueBuf(b []byte) ([]byte, error)

type Subscription 

type Subscription struct {

	// If ENABLED, the subscription will be automatically renewed at the end of
	// the existing subscription period.
	//
	// When you initally create a subscription, AutoRenew is set to ENABLED. You
	// can change this by submitting an UpdateSubscription request. If the UpdateSubscription
	// request does not included a value for AutoRenew, the existing value for AutoRenew
	// remains unchanged.
	AutoRenew AutoRenew `type:"string" enum:"true"`

	// The date and time your subscription will end.
	EndTime *time.Time `type:"timestamp"`

	// Specifies how many protections of a given type you can create.
	Limits []Limit `type:"list"`

	// The start time of the subscription, in Unix time in seconds. For more information
	// see timestamp (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	StartTime *time.Time `type:"timestamp"`

	// The length, in seconds, of the AWS Shield Advanced subscription for the account.
	TimeCommitmentInSeconds *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about the AWS Shield Advanced subscription for an account.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation

type SubscriptionState added in v0.2.0 

type SubscriptionState string
const (
	SubscriptionStateActive   SubscriptionState = "ACTIVE"
	SubscriptionStateInactive SubscriptionState = "INACTIVE"
)

Enum values for SubscriptionState

func (SubscriptionState) MarshalValue added in v0.3.0 

func (enum SubscriptionState) MarshalValue() (string, error)

func (SubscriptionState) MarshalValueBuf added in v0.3.0 

func (enum SubscriptionState) MarshalValueBuf(b []byte) ([]byte, error)

type SummarizedAttackVector 

type SummarizedAttackVector struct {

	// The list of counters that describe the details of the attack.
	VectorCounters []SummarizedCounter `type:"list"`

	// The attack type, for example, SNMP reflection or SYN flood.
	//
	// VectorType is a required field
	VectorType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A summary of information about the attack.

func (SummarizedAttackVector) String 

func (s SummarizedAttackVector) String() string

String returns the string representation

type SummarizedCounter 

type SummarizedCounter struct {

	// The average value of the counter for a specified time period.
	Average *float64 `type:"double"`

	// The maximum value of the counter for a specified time period.
	Max *float64 `type:"double"`

	// The number of counters for a specified time period.
	N *int64 `type:"integer"`

	// The counter name.
	Name *string `type:"string"`

	// The total of counter values for a specified time period.
	Sum *float64 `type:"double"`

	// The unit of the counters.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

The counter that describes a DDoS attack.

func (SummarizedCounter) String 

func (s SummarizedCounter) String() string

String returns the string representation

type TimeRange 

type TimeRange struct {

	// The start time, in Unix time in seconds. For more information see timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	FromInclusive *time.Time `type:"timestamp"`

	// The end time, in Unix time in seconds. For more information see timestamp
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types).
	ToExclusive *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The time range.

func (TimeRange) String 

func (s TimeRange) String() string

String returns the string representation

type Unit added in v0.2.0 

type Unit string
const (
	UnitBits     Unit = "BITS"
	UnitBytes    Unit = "BYTES"
	UnitPackets  Unit = "PACKETS"
	UnitRequests Unit = "REQUESTS"
)

Enum values for Unit

func (Unit) MarshalValue added in v0.3.0 

func (enum Unit) MarshalValue() (string, error)

func (Unit) MarshalValueBuf added in v0.3.0 

func (enum Unit) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateEmergencyContactSettingsInput added in v0.5.0 

type UpdateEmergencyContactSettingsInput struct {

	// A list of email addresses that the DRT can use to contact you during a suspected
	// attack.
	EmergencyContactList []EmergencyContact `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateEmergencyContactSettingsInput) String added in v0.5.0 

func (s UpdateEmergencyContactSettingsInput) String() string

String returns the string representation

func (*UpdateEmergencyContactSettingsInput) Validate added in v0.5.0 

func (s *UpdateEmergencyContactSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEmergencyContactSettingsOutput added in v0.5.0 

type UpdateEmergencyContactSettingsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateEmergencyContactSettingsOutput) String added in v0.5.0 

func (s UpdateEmergencyContactSettingsOutput) String() string

String returns the string representation

type UpdateEmergencyContactSettingsRequest added in v0.5.0 

type UpdateEmergencyContactSettingsRequest struct {
	*aws.Request
	Input *UpdateEmergencyContactSettingsInput
	Copy  func(*UpdateEmergencyContactSettingsInput) UpdateEmergencyContactSettingsRequest
}

UpdateEmergencyContactSettingsRequest is the request type for the UpdateEmergencyContactSettings API operation.

func (UpdateEmergencyContactSettingsRequest) Send added in v0.5.0 

func (r UpdateEmergencyContactSettingsRequest) Send(ctx context.Context) (*UpdateEmergencyContactSettingsResponse, error)

Send marshals and sends the UpdateEmergencyContactSettings API request.

type UpdateEmergencyContactSettingsResponse added in v0.9.0 

type UpdateEmergencyContactSettingsResponse struct {
	*UpdateEmergencyContactSettingsOutput
	// contains filtered or unexported fields
}

UpdateEmergencyContactSettingsResponse is the response type for the UpdateEmergencyContactSettings API operation.

func (*UpdateEmergencyContactSettingsResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateEmergencyContactSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateEmergencyContactSettings request.

type UpdateSubscriptionInput added in v0.5.0 

type UpdateSubscriptionInput struct {

	// When you initally create a subscription, AutoRenew is set to ENABLED. If
	// ENABLED, the subscription will be automatically renewed at the end of the
	// existing subscription period. You can change this by submitting an UpdateSubscription
	// request. If the UpdateSubscription request does not included a value for
	// AutoRenew, the existing value for AutoRenew remains unchanged.
	AutoRenew AutoRenew `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateSubscriptionInput) String added in v0.5.0 

func (s UpdateSubscriptionInput) String() string

String returns the string representation

type UpdateSubscriptionOutput added in v0.5.0 

type UpdateSubscriptionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateSubscriptionOutput) String added in v0.5.0 

func (s UpdateSubscriptionOutput) String() string

String returns the string representation

type UpdateSubscriptionRequest added in v0.5.0 

type UpdateSubscriptionRequest struct {
	*aws.Request
	Input *UpdateSubscriptionInput
	Copy  func(*UpdateSubscriptionInput) UpdateSubscriptionRequest
}

UpdateSubscriptionRequest is the request type for the UpdateSubscription API operation.

func (UpdateSubscriptionRequest) Send added in v0.5.0 

func (r UpdateSubscriptionRequest) Send(ctx context.Context) (*UpdateSubscriptionResponse, error)

Send marshals and sends the UpdateSubscription API request.

type UpdateSubscriptionResponse added in v0.9.0 

type UpdateSubscriptionResponse struct {
	*UpdateSubscriptionOutput
	// contains filtered or unexported fields
}

UpdateSubscriptionResponse is the response type for the UpdateSubscription API operation.

func (*UpdateSubscriptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateSubscriptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSubscription request.

Source Files

View all Source files

Directories

Path Synopsis
Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.
 Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.