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.

ExtendedS3DestinationDescription

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

type ExtendedS3DestinationDescription struct { BucketARN *string `min:"1" type:"string" required:"true"` BufferingHints *BufferingHints `type:"structure" required:"true"` CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` CompressionFormat *string `type:"string" required:"true" enum:"CompressionFormat"` DataFormatConversionConfiguration *DataFormatConversionConfiguration `type:"structure"` EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"` ErrorOutputPrefix *string `type:"string"` Prefix *string `type:"string"` ProcessingConfiguration *ProcessingConfiguration `type:"structure"` RoleARN *string `min:"1" type:"string" required:"true"` S3BackupDescription *S3DestinationDescription `type:"structure"` S3BackupMode *string `type:"string" enum:"S3BackupMode"` }

Describes 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.

CompressionFormat is a required field

DataFormatConversionConfiguration

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html).

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.

ProcessingConfiguration

Describes a data processing configuration.

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

S3BackupDescription

Describes a destination in Amazon S3.

S3BackupMode

Type: *string

The Amazon S3 backup mode.

Method

GoString

func (s ExtendedS3DestinationDescription) GoString() string

GoString returns the string representation

SetBucketARN

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

SetBucketARN sets the BucketARN field's value.

SetBufferingHints

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

SetBufferingHints sets the BufferingHints field's value.

SetCloudWatchLoggingOptions

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

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetCompressionFormat

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

SetCompressionFormat sets the CompressionFormat field's value.

SetDataFormatConversionConfiguration

func (s *ExtendedS3DestinationDescription) SetDataFormatConversionConfiguration(v *DataFormatConversionConfiguration) *ExtendedS3DestinationDescription

SetDataFormatConversionConfiguration sets the DataFormatConversionConfiguration field's value.

SetEncryptionConfiguration

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

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

SetErrorOutputPrefix

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

SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.

SetPrefix

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

SetPrefix sets the Prefix field's value.

SetProcessingConfiguration

func (s *ExtendedS3DestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *ExtendedS3DestinationDescription

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

SetRoleARN

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

SetRoleARN sets the RoleARN field's value.

SetS3BackupDescription

func (s *ExtendedS3DestinationDescription) SetS3BackupDescription(v *S3DestinationDescription) *ExtendedS3DestinationDescription

SetS3BackupDescription sets the S3BackupDescription field's value.

SetS3BackupMode

func (s *ExtendedS3DestinationDescription) SetS3BackupMode(v string) *ExtendedS3DestinationDescription

SetS3BackupMode sets the S3BackupMode field's value.

String

func (s ExtendedS3DestinationDescription) String() string

String returns the string representation

On this page: