AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DeliveryChannel

import "github.com/aws/aws-sdk-go/service/configservice"

type DeliveryChannel struct { ConfigSnapshotDeliveryProperties *ConfigSnapshotDeliveryProperties `locationName:"configSnapshotDeliveryProperties" type:"structure"` Name *string `locationName:"name" min:"1" type:"string"` S3BucketName *string `locationName:"s3BucketName" type:"string"` S3KeyPrefix *string `locationName:"s3KeyPrefix" type:"string"` SnsTopicARN *string `locationName:"snsTopicARN" type:"string"` }

The channel through which AWS Config delivers notifications and updated configuration states.

ConfigSnapshotDeliveryProperties

Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:

The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

  • The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for AWS Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule.

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value.

For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.

You specify the MaximumExecutionFrequency value for Six_Hours.

You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.

Name

Type: *string

The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

S3BucketName

Type: *string

The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the AWS Config Developer Guide.

S3KeyPrefix

Type: *string

The prefix for the specified Amazon S3 bucket.

SnsTopicARN

Type: *string

The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic (https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the AWS Config Developer Guide.

Method

GoString

func (s DeliveryChannel) GoString() string

GoString returns the string representation

SetConfigSnapshotDeliveryProperties

func (s *DeliveryChannel) SetConfigSnapshotDeliveryProperties(v *ConfigSnapshotDeliveryProperties) *DeliveryChannel

SetConfigSnapshotDeliveryProperties sets the ConfigSnapshotDeliveryProperties field's value.

SetName

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

SetName sets the Name field's value.

SetS3BucketName

func (s *DeliveryChannel) SetS3BucketName(v string) *DeliveryChannel

SetS3BucketName sets the S3BucketName field's value.

SetS3KeyPrefix

func (s *DeliveryChannel) SetS3KeyPrefix(v string) *DeliveryChannel

SetS3KeyPrefix sets the S3KeyPrefix field's value.

SetSnsTopicARN

func (s *DeliveryChannel) SetSnsTopicARN(v string) *DeliveryChannel

SetSnsTopicARN sets the SnsTopicARN field's value.

String

func (s DeliveryChannel) String() string

String returns the string representation

Validate

func (s *DeliveryChannel) Validate() error

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

On this page: