shield

package
v2.0.0-preview.1+incom... Latest Latest
Warning

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

 Go to latest Published: Dec 21, 2017 License: Apache-2.0, Apache-2.0 Imports: 5 Imported by: 0

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 (http://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 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 Shield 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 (

	// 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"

	// 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.
	ErrCodeLimitsExceededException = "LimitsExceededException"

	// ErrCodeLockedSubscriptionException for service response error code
	// "LockedSubscriptionException".
	//
	// Exception that indicates that the subscription has been modified by another
	// client. You can retry the request.
	ErrCodeLockedSubscriptionException = "LockedSubscriptionException"

	// 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"
)
View Source 
const (
	ServiceName = "shield"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

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 time the attack ended, in the format 2016-12-16T13:50Z.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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 the format 2016-12-16T13:50Z.
	StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackDetail

func (AttackDetail) GoString 

func (s AttackDetail) GoString() string

GoString returns the string representation

func (*AttackDetail) SetAttackCounters 

func (s *AttackDetail) SetAttackCounters(v []SummarizedCounter) *AttackDetail

SetAttackCounters sets the AttackCounters field's value.

func (*AttackDetail) SetAttackId 

func (s *AttackDetail) SetAttackId(v string) *AttackDetail

SetAttackId sets the AttackId field's value.

func (*AttackDetail) SetEndTime 

func (s *AttackDetail) SetEndTime(v time.Time) *AttackDetail

SetEndTime sets the EndTime field's value.

func (*AttackDetail) SetMitigations 

func (s *AttackDetail) SetMitigations(v []Mitigation) *AttackDetail

SetMitigations sets the Mitigations field's value.

func (*AttackDetail) SetResourceArn 

func (s *AttackDetail) SetResourceArn(v string) *AttackDetail

SetResourceArn sets the ResourceArn field's value.

func (*AttackDetail) SetStartTime 

func (s *AttackDetail) SetStartTime(v time.Time) *AttackDetail

SetStartTime sets the StartTime field's value.

func (*AttackDetail) SetSubResources 

func (s *AttackDetail) SetSubResources(v []SubResourceSummary) *AttackDetail

SetSubResources sets the SubResources field's value.

func (AttackDetail) String 

func (s AttackDetail) String() string

String returns the string representation

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 the format 2016-12-16T13:50Z.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

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

	// The start time of the attack, in the format 2016-12-16T13:50Z.
	StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Summarizes all DDoS attacks for a specified time period. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackSummary

func (AttackSummary) GoString 

func (s AttackSummary) GoString() string

GoString returns the string representation

func (*AttackSummary) SetAttackId 

func (s *AttackSummary) SetAttackId(v string) *AttackSummary

SetAttackId sets the AttackId field's value.

func (*AttackSummary) SetAttackVectors 

func (s *AttackSummary) SetAttackVectors(v []AttackVectorDescription) *AttackSummary

SetAttackVectors sets the AttackVectors field's value.

func (*AttackSummary) SetEndTime 

func (s *AttackSummary) SetEndTime(v time.Time) *AttackSummary

SetEndTime sets the EndTime field's value.

func (*AttackSummary) SetResourceArn 

func (s *AttackSummary) SetResourceArn(v string) *AttackSummary

SetResourceArn sets the ResourceArn field's value.

func (*AttackSummary) SetStartTime 

func (s *AttackSummary) SetStartTime(v time.Time) *AttackSummary

SetStartTime sets the StartTime field's value.

func (AttackSummary) String 

func (s AttackSummary) String() string

String returns the string representation

type AttackVectorDescription 

type AttackVectorDescription struct {

	// 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
}

Describes the attack. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackVectorDescription

func (AttackVectorDescription) GoString 

func (s AttackVectorDescription) GoString() string

GoString returns the string representation

func (*AttackVectorDescription) SetVectorType 

func (s *AttackVectorDescription) SetVectorType(v string) *AttackVectorDescription

SetVectorType sets the VectorType field's value.

func (AttackVectorDescription) String 

func (s AttackVectorDescription) 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.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CreateProtectionInput) GoString 

func (s CreateProtectionInput) GoString() string

GoString returns the string representation

func (*CreateProtectionInput) SetName 

func (s *CreateProtectionInput) SetName(v string) *CreateProtectionInput

SetName sets the Name field's value.

func (*CreateProtectionInput) SetResourceArn 

func (s *CreateProtectionInput) SetResourceArn(v string) *CreateProtectionInput

SetResourceArn sets the ResourceArn field's value.

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
}

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

func (CreateProtectionOutput) GoString 

func (s CreateProtectionOutput) GoString() string

GoString returns the string representation

func (CreateProtectionOutput) SDKResponseMetadata 

func (s CreateProtectionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*CreateProtectionOutput) SetProtectionId 

func (s *CreateProtectionOutput) SetProtectionId(v string) *CreateProtectionOutput

SetProtectionId sets the ProtectionId field's value.

func (CreateProtectionOutput) String 

func (s CreateProtectionOutput) String() string

String returns the string representation

type CreateProtectionRequest 

type CreateProtectionRequest struct {
	*aws.Request
	Input *CreateProtectionInput
}

CreateProtectionRequest is a API request type for the CreateProtection API operation.

func (CreateProtectionRequest) Send 

func (r CreateProtectionRequest) Send() (*CreateProtectionOutput, error)

Send marshals and sends the CreateProtection API request.

type CreateSubscriptionInput 

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

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

func (CreateSubscriptionInput) GoString 

func (s CreateSubscriptionInput) GoString() string

GoString returns the string representation

func (CreateSubscriptionInput) String 

func (s CreateSubscriptionInput) String() string

String returns the string representation

type CreateSubscriptionOutput 

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

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

func (CreateSubscriptionOutput) GoString 

func (s CreateSubscriptionOutput) GoString() string

GoString returns the string representation

func (CreateSubscriptionOutput) SDKResponseMetadata 

func (s CreateSubscriptionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateSubscriptionOutput) String 

func (s CreateSubscriptionOutput) String() string

String returns the string representation

type CreateSubscriptionRequest 

type CreateSubscriptionRequest struct {
	*aws.Request
	Input *CreateSubscriptionInput
}

CreateSubscriptionRequest is a API request type for the CreateSubscription API operation.

func (CreateSubscriptionRequest) Send 

func (r CreateSubscriptionRequest) Send() (*CreateSubscriptionOutput, error)

Send marshals and sends the CreateSubscription API 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
}

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

func (DeleteProtectionInput) GoString 

func (s DeleteProtectionInput) GoString() string

GoString returns the string representation

func (*DeleteProtectionInput) SetProtectionId 

func (s *DeleteProtectionInput) SetProtectionId(v string) *DeleteProtectionInput

SetProtectionId sets the ProtectionId field's value.

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
}

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

func (DeleteProtectionOutput) GoString 

func (s DeleteProtectionOutput) GoString() string

GoString returns the string representation

func (DeleteProtectionOutput) SDKResponseMetadata 

func (s DeleteProtectionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteProtectionOutput) String 

func (s DeleteProtectionOutput) String() string

String returns the string representation

type DeleteProtectionRequest 

type DeleteProtectionRequest struct {
	*aws.Request
	Input *DeleteProtectionInput
}

DeleteProtectionRequest is a API request type for the DeleteProtection API operation.

func (DeleteProtectionRequest) Send 

func (r DeleteProtectionRequest) Send() (*DeleteProtectionOutput, error)

Send marshals and sends the DeleteProtection API request.

type DeleteSubscriptionInput 

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

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

func (DeleteSubscriptionInput) GoString 

func (s DeleteSubscriptionInput) GoString() string

GoString returns the string representation

func (DeleteSubscriptionInput) String 

func (s DeleteSubscriptionInput) String() string

String returns the string representation

type DeleteSubscriptionOutput 

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

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

func (DeleteSubscriptionOutput) GoString 

func (s DeleteSubscriptionOutput) GoString() string

GoString returns the string representation

func (DeleteSubscriptionOutput) SDKResponseMetadata 

func (s DeleteSubscriptionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteSubscriptionOutput) String 

func (s DeleteSubscriptionOutput) String() string

String returns the string representation

type DeleteSubscriptionRequest 

type DeleteSubscriptionRequest struct {
	*aws.Request
	Input *DeleteSubscriptionInput
}

DeleteSubscriptionRequest is a API request type for the DeleteSubscription API operation.

func (DeleteSubscriptionRequest) Send 

func (r DeleteSubscriptionRequest) Send() (*DeleteSubscriptionOutput, error)

Send marshals and sends the DeleteSubscription API 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
}

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

func (DescribeAttackInput) GoString 

func (s DescribeAttackInput) GoString() string

GoString returns the string representation

func (*DescribeAttackInput) SetAttackId 

func (s *DescribeAttackInput) SetAttackId(v string) *DescribeAttackInput

SetAttackId sets the AttackId field's value.

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
}

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

func (DescribeAttackOutput) GoString 

func (s DescribeAttackOutput) GoString() string

GoString returns the string representation

func (DescribeAttackOutput) SDKResponseMetadata 

func (s DescribeAttackOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeAttackOutput) SetAttack 

func (s *DescribeAttackOutput) SetAttack(v *AttackDetail) *DescribeAttackOutput

SetAttack sets the Attack field's value.

func (DescribeAttackOutput) String 

func (s DescribeAttackOutput) String() string

String returns the string representation

type DescribeAttackRequest 

type DescribeAttackRequest struct {
	*aws.Request
	Input *DescribeAttackInput
}

DescribeAttackRequest is a API request type for the DescribeAttack API operation.

func (DescribeAttackRequest) Send 

func (r DescribeAttackRequest) Send() (*DescribeAttackOutput, error)

Send marshals and sends the DescribeAttack API request.

type DescribeProtectionInput 

type DescribeProtectionInput struct {

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

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

func (DescribeProtectionInput) GoString 

func (s DescribeProtectionInput) GoString() string

GoString returns the string representation

func (*DescribeProtectionInput) SetProtectionId 

func (s *DescribeProtectionInput) SetProtectionId(v string) *DescribeProtectionInput

SetProtectionId sets the ProtectionId field's value.

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
}

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

func (DescribeProtectionOutput) GoString 

func (s DescribeProtectionOutput) GoString() string

GoString returns the string representation

func (DescribeProtectionOutput) SDKResponseMetadata 

func (s DescribeProtectionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeProtectionOutput) SetProtection 

func (s *DescribeProtectionOutput) SetProtection(v *Protection) *DescribeProtectionOutput

SetProtection sets the Protection field's value.

func (DescribeProtectionOutput) String 

func (s DescribeProtectionOutput) String() string

String returns the string representation

type DescribeProtectionRequest 

type DescribeProtectionRequest struct {
	*aws.Request
	Input *DescribeProtectionInput
}

DescribeProtectionRequest is a API request type for the DescribeProtection API operation.

func (DescribeProtectionRequest) Send 

func (r DescribeProtectionRequest) Send() (*DescribeProtectionOutput, error)

Send marshals and sends the DescribeProtection API request.

type DescribeSubscriptionInput 

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

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

func (DescribeSubscriptionInput) GoString 

func (s DescribeSubscriptionInput) GoString() string

GoString returns the string representation

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
}

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

func (DescribeSubscriptionOutput) GoString 

func (s DescribeSubscriptionOutput) GoString() string

GoString returns the string representation

func (DescribeSubscriptionOutput) SDKResponseMetadata 

func (s DescribeSubscriptionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeSubscriptionOutput) SetSubscription 

func (s *DescribeSubscriptionOutput) SetSubscription(v *Subscription) *DescribeSubscriptionOutput

SetSubscription sets the Subscription field's value.

func (DescribeSubscriptionOutput) String 

func (s DescribeSubscriptionOutput) String() string

String returns the string representation

type DescribeSubscriptionRequest 

type DescribeSubscriptionRequest struct {
	*aws.Request
	Input *DescribeSubscriptionInput
}

DescribeSubscriptionRequest is a API request type for the DescribeSubscription API operation.

func (DescribeSubscriptionRequest) Send 

func (r DescribeSubscriptionRequest) Send() (*DescribeSubscriptionOutput, error)

Send marshals and sends the DescribeSubscription API request.

type ListAttacksInput 

type ListAttacksInput struct {

	// The end of the time period for the attacks.
	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.
	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 time period for the attacks.
	StartTime *TimeRange `type:"structure"`
	// contains filtered or unexported fields
}

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

func (ListAttacksInput) GoString 

func (s ListAttacksInput) GoString() string

GoString returns the string representation

func (*ListAttacksInput) SetEndTime 

func (s *ListAttacksInput) SetEndTime(v *TimeRange) *ListAttacksInput

SetEndTime sets the EndTime field's value.

func (*ListAttacksInput) SetMaxResults 

func (s *ListAttacksInput) SetMaxResults(v int64) *ListAttacksInput

SetMaxResults sets the MaxResults field's value.

func (*ListAttacksInput) SetNextToken 

func (s *ListAttacksInput) SetNextToken(v string) *ListAttacksInput

SetNextToken sets the NextToken field's value.

func (*ListAttacksInput) SetResourceArns 

func (s *ListAttacksInput) SetResourceArns(v []string) *ListAttacksInput

SetResourceArns sets the ResourceArns field's value.

func (*ListAttacksInput) SetStartTime 

func (s *ListAttacksInput) SetStartTime(v *TimeRange) *ListAttacksInput

SetStartTime sets the StartTime field's value.

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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListAttacksOutput) GoString 

func (s ListAttacksOutput) GoString() string

GoString returns the string representation

func (ListAttacksOutput) SDKResponseMetadata 

func (s ListAttacksOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListAttacksOutput) SetAttackSummaries 

func (s *ListAttacksOutput) SetAttackSummaries(v []AttackSummary) *ListAttacksOutput

SetAttackSummaries sets the AttackSummaries field's value.

func (*ListAttacksOutput) SetNextToken 

func (s *ListAttacksOutput) SetNextToken(v string) *ListAttacksOutput

SetNextToken sets the NextToken field's value.

func (ListAttacksOutput) String 

func (s ListAttacksOutput) String() string

String returns the string representation

type ListAttacksRequest 

type ListAttacksRequest struct {
	*aws.Request
	Input *ListAttacksInput
}

ListAttacksRequest is a API request type for the ListAttacks API operation.

func (ListAttacksRequest) Send 

func (r ListAttacksRequest) Send() (*ListAttacksOutput, error)

Send marshals and sends the ListAttacks API 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.
	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
}

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

func (ListProtectionsInput) GoString 

func (s ListProtectionsInput) GoString() string

GoString returns the string representation

func (*ListProtectionsInput) SetMaxResults 

func (s *ListProtectionsInput) SetMaxResults(v int64) *ListProtectionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListProtectionsInput) SetNextToken 

func (s *ListProtectionsInput) SetNextToken(v string) *ListProtectionsInput

SetNextToken sets the NextToken field's value.

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.
	NextToken *string `min:"1" type:"string"`

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

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

func (ListProtectionsOutput) GoString 

func (s ListProtectionsOutput) GoString() string

GoString returns the string representation

func (ListProtectionsOutput) SDKResponseMetadata 

func (s ListProtectionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListProtectionsOutput) SetNextToken 

func (s *ListProtectionsOutput) SetNextToken(v string) *ListProtectionsOutput

SetNextToken sets the NextToken field's value.

func (*ListProtectionsOutput) SetProtections 

func (s *ListProtectionsOutput) SetProtections(v []Protection) *ListProtectionsOutput

SetProtections sets the Protections field's value.

func (ListProtectionsOutput) String 

func (s ListProtectionsOutput) String() string

String returns the string representation

type ListProtectionsRequest 

type ListProtectionsRequest struct {
	*aws.Request
	Input *ListProtectionsInput
}

ListProtectionsRequest is a API request type for the ListProtections API operation.

func (ListProtectionsRequest) Send 

func (r ListProtectionsRequest) Send() (*ListProtectionsOutput, error)

Send marshals and sends the ListProtections API 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Mitigation

func (Mitigation) GoString 

func (s Mitigation) GoString() string

GoString returns the string representation

func (*Mitigation) SetMitigationName 

func (s *Mitigation) SetMitigationName(v string) *Mitigation

SetMitigationName sets the MitigationName field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Protection

func (Protection) GoString 

func (s Protection) GoString() string

GoString returns the string representation

func (*Protection) SetId 

func (s *Protection) SetId(v string) *Protection

SetId sets the Id field's value.

func (*Protection) SetName 

func (s *Protection) SetName(v string) *Protection

SetName sets the Name field's value.

func (*Protection) SetResourceArn 

func (s *Protection) SetResourceArn(v string) *Protection

SetResourceArn sets the ResourceArn field's value.

func (Protection) String 

func (s Protection) String() string

String returns the string representation

type Shield 

type Shield struct {
	*aws.Client
}

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

Shield 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) *Shield

New creates a new instance of the Shield client with a config. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

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

// Create a Shield client with additional configuration
svc := shield.New(myConfig, aws.NewConfig().WithRegion("us-west-2"))

func (*Shield) CreateProtectionRequest 

func (c *Shield) 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, or an Amazon Route 53 hosted zone. 

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

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

func (*Shield) CreateSubscriptionRequest 

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

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

Activates AWS Shield Advanced for an account. 

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

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

func (*Shield) DeleteProtectionRequest 

func (c *Shield) 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 the DeleteProtectionRequest method.
req := client.DeleteProtectionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Shield) DeleteSubscriptionRequest 

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

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

Removes AWS Shield Advanced from an account. 

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

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

func (*Shield) DescribeAttackRequest 

func (c *Shield) 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 the DescribeAttackRequest method.
req := client.DescribeAttackRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Shield) DescribeProtectionRequest 

func (c *Shield) 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 the DescribeProtectionRequest method.
req := client.DescribeProtectionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Shield) DescribeSubscriptionRequest 

func (c *Shield) 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 the DescribeSubscriptionRequest method.
req := client.DescribeSubscriptionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Shield) ListAttacksRequest 

func (c *Shield) 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 the ListAttacksRequest method.
req := client.ListAttacksRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Shield) ListProtectionsRequest 

func (c *Shield) 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 the ListProtectionsRequest method.
req := client.ListProtectionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SubResourceSummary

func (SubResourceSummary) GoString 

func (s SubResourceSummary) GoString() string

GoString returns the string representation

func (*SubResourceSummary) SetAttackVectors 

func (s *SubResourceSummary) SetAttackVectors(v []SummarizedAttackVector) *SubResourceSummary

SetAttackVectors sets the AttackVectors field's value.

func (*SubResourceSummary) SetCounters 

func (s *SubResourceSummary) SetCounters(v []SummarizedCounter) *SubResourceSummary

SetCounters sets the Counters field's value.

func (*SubResourceSummary) SetId 

func (s *SubResourceSummary) SetId(v string) *SubResourceSummary

SetId sets the Id field's value.

func (*SubResourceSummary) SetType 

func (s *SubResourceSummary) SetType(v SubResourceType) *SubResourceSummary

SetType sets the Type field's value.

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

type Subscription 

type Subscription struct {

	// The start time of the subscription, in the format "2016-12-16T13:50Z".
	StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Subscription

func (Subscription) GoString 

func (s Subscription) GoString() string

GoString returns the string representation

func (*Subscription) SetStartTime 

func (s *Subscription) SetStartTime(v time.Time) *Subscription

SetStartTime sets the StartTime field's value.

func (*Subscription) SetTimeCommitmentInSeconds 

func (s *Subscription) SetTimeCommitmentInSeconds(v int64) *Subscription

SetTimeCommitmentInSeconds sets the TimeCommitmentInSeconds field's value.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SummarizedAttackVector

func (SummarizedAttackVector) GoString 

func (s SummarizedAttackVector) GoString() string

GoString returns the string representation

func (*SummarizedAttackVector) SetVectorCounters 

func (s *SummarizedAttackVector) SetVectorCounters(v []SummarizedCounter) *SummarizedAttackVector

SetVectorCounters sets the VectorCounters field's value.

func (*SummarizedAttackVector) SetVectorType 

func (s *SummarizedAttackVector) SetVectorType(v string) *SummarizedAttackVector

SetVectorType sets the VectorType field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SummarizedCounter

func (SummarizedCounter) GoString 

func (s SummarizedCounter) GoString() string

GoString returns the string representation

func (*SummarizedCounter) SetAverage 

func (s *SummarizedCounter) SetAverage(v float64) *SummarizedCounter

SetAverage sets the Average field's value.

func (*SummarizedCounter) SetMax 

func (s *SummarizedCounter) SetMax(v float64) *SummarizedCounter

SetMax sets the Max field's value.

func (*SummarizedCounter) SetN 

func (s *SummarizedCounter) SetN(v int64) *SummarizedCounter

SetN sets the N field's value.

func (*SummarizedCounter) SetName 

func (s *SummarizedCounter) SetName(v string) *SummarizedCounter

SetName sets the Name field's value.

func (*SummarizedCounter) SetSum 

func (s *SummarizedCounter) SetSum(v float64) *SummarizedCounter

SetSum sets the Sum field's value.

func (*SummarizedCounter) SetUnit 

func (s *SummarizedCounter) SetUnit(v string) *SummarizedCounter

SetUnit sets the Unit field's value.

func (SummarizedCounter) String 

func (s SummarizedCounter) String() string

String returns the string representation

type TimeRange 

type TimeRange struct {

	// The start time, in the format 2016-12-16T13:50Z.
	FromInclusive *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The end time, in the format 2016-12-16T15:50Z.
	ToExclusive *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The time range. Please also see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/TimeRange

func (TimeRange) GoString 

func (s TimeRange) GoString() string

GoString returns the string representation

func (*TimeRange) SetFromInclusive 

func (s *TimeRange) SetFromInclusive(v time.Time) *TimeRange

SetFromInclusive sets the FromInclusive field's value.

func (*TimeRange) SetToExclusive 

func (s *TimeRange) SetToExclusive(v time.Time) *TimeRange

SetToExclusive sets the ToExclusive field's value.

func (TimeRange) String 

func (s TimeRange) String() string

String returns the string representation

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.