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.

S3DestinationConfiguration

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

type S3DestinationConfiguration struct { BucketARN *string `min:"1" type:"string" required:"true"` BufferingHints *BufferingHints `type:"structure"` CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` CompressionFormat *string `type:"string" enum:"CompressionFormat"` EncryptionConfiguration *EncryptionConfiguration `type:"structure"` ErrorOutputPrefix *string `type:"string"` Prefix *string `type:"string"` RoleARN *string `min:"1" type:"string" required:"true"` }

Describes the configuration of a destination in Amazon S3.

BucketARN

Type: *string

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

BucketARN is a required field

BufferingHints

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal.

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

CompressionFormat

Type: *string

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

EncryptionConfiguration

Describes the encryption for a destination in Amazon S3.

ErrorOutputPrefix

Type: *string

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.

Prefix

Type: *string

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name) in the Amazon Kinesis Data Firehose Developer Guide.

RoleARN

Type: *string

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

RoleARN is a required field

Method

GoString

func (s S3DestinationConfiguration) GoString() string

GoString returns the string representation

SetBucketARN

func (s *S3DestinationConfiguration) SetBucketARN(v string) *S3DestinationConfiguration

SetBucketARN sets the BucketARN field's value.

SetBufferingHints

func (s *S3DestinationConfiguration) SetBufferingHints(v *BufferingHints) *S3DestinationConfiguration

SetBufferingHints sets the BufferingHints field's value.

SetCloudWatchLoggingOptions

func (s *S3DestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *S3DestinationConfiguration

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetCompressionFormat

func (s *S3DestinationConfiguration) SetCompressionFormat(v string) *S3DestinationConfiguration

SetCompressionFormat sets the CompressionFormat field's value.

SetEncryptionConfiguration

func (s *S3DestinationConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *S3DestinationConfiguration

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

SetErrorOutputPrefix

func (s *S3DestinationConfiguration) SetErrorOutputPrefix(v string) *S3DestinationConfiguration

SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.

SetPrefix

func (s *S3DestinationConfiguration) SetPrefix(v string) *S3DestinationConfiguration

SetPrefix sets the Prefix field's value.

SetRoleARN

func (s *S3DestinationConfiguration) SetRoleARN(v string) *S3DestinationConfiguration

SetRoleARN sets the RoleARN field's value.

String

func (s S3DestinationConfiguration) String() string

String returns the string representation

Validate

func (s *S3DestinationConfiguration) Validate() error

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

On this page: