func AmazonOpenSearchServerlessS3BackupMode_Values() []string
AmazonOpenSearchServerlessS3BackupMode_Values returns all elements of the AmazonOpenSearchServerlessS3BackupMode enum
func AmazonopensearchserviceIndexRotationPeriod_Values() []string
AmazonopensearchserviceIndexRotationPeriod_Values returns all elements of the AmazonopensearchserviceIndexRotationPeriod enum
func AmazonopensearchserviceS3BackupMode_Values() []string
AmazonopensearchserviceS3BackupMode_Values returns all elements of the AmazonopensearchserviceS3BackupMode enum
func CompressionFormat_Values() []string
CompressionFormat_Values returns all elements of the CompressionFormat enum
func Connectivity_Values() []string
Connectivity_Values returns all elements of the Connectivity enum
func ContentEncoding_Values() []string
ContentEncoding_Values returns all elements of the ContentEncoding enum
func DefaultDocumentIdFormat_Values() []string
DefaultDocumentIdFormat_Values returns all elements of the DefaultDocumentIdFormat enum
func DeliveryStreamEncryptionStatus_Values() []string
DeliveryStreamEncryptionStatus_Values returns all elements of the DeliveryStreamEncryptionStatus enum
func DeliveryStreamFailureType_Values() []string
DeliveryStreamFailureType_Values returns all elements of the DeliveryStreamFailureType enum
func DeliveryStreamStatus_Values() []string
DeliveryStreamStatus_Values returns all elements of the DeliveryStreamStatus enum
func DeliveryStreamType_Values() []string
DeliveryStreamType_Values returns all elements of the DeliveryStreamType enum
func ElasticsearchIndexRotationPeriod_Values() []string
ElasticsearchIndexRotationPeriod_Values returns all elements of the ElasticsearchIndexRotationPeriod enum
func ElasticsearchS3BackupMode_Values() []string
ElasticsearchS3BackupMode_Values returns all elements of the ElasticsearchS3BackupMode enum
func HECEndpointType_Values() []string
HECEndpointType_Values returns all elements of the HECEndpointType enum
func HttpEndpointS3BackupMode_Values() []string
HttpEndpointS3BackupMode_Values returns all elements of the HttpEndpointS3BackupMode enum
func IcebergS3BackupMode_Values() []string
IcebergS3BackupMode_Values returns all elements of the IcebergS3BackupMode enum
func KeyType_Values() []string
KeyType_Values returns all elements of the KeyType enum
func NoEncryptionConfig_Values() []string
NoEncryptionConfig_Values returns all elements of the NoEncryptionConfig enum
func OrcCompression_Values() []string
OrcCompression_Values returns all elements of the OrcCompression enum
func OrcFormatVersion_Values() []string
OrcFormatVersion_Values returns all elements of the OrcFormatVersion enum
func ParquetCompression_Values() []string
ParquetCompression_Values returns all elements of the ParquetCompression enum
func ParquetWriterVersion_Values() []string
ParquetWriterVersion_Values returns all elements of the ParquetWriterVersion enum
func ProcessorParameterName_Values() []string
ProcessorParameterName_Values returns all elements of the ProcessorParameterName enum
func ProcessorType_Values() []string
ProcessorType_Values returns all elements of the ProcessorType enum
func RedshiftS3BackupMode_Values() []string
RedshiftS3BackupMode_Values returns all elements of the RedshiftS3BackupMode enum
func S3BackupMode_Values() []string
S3BackupMode_Values returns all elements of the S3BackupMode enum
func SnowflakeDataLoadingOption_Values() []string
SnowflakeDataLoadingOption_Values returns all elements of the SnowflakeDataLoadingOption enum
func SnowflakeS3BackupMode_Values() []string
SnowflakeS3BackupMode_Values returns all elements of the SnowflakeS3BackupMode enum
func SplunkS3BackupMode_Values() []string
SplunkS3BackupMode_Values returns all elements of the SplunkS3BackupMode enum
type AmazonOpenSearchServerlessBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300 (5 minutes). IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 5. // // We recommend setting this parameter to a value greater than the amount of // data you typically ingest into the delivery stream in 10 seconds. For example, // if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
func (s AmazonOpenSearchServerlessBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessBufferingHints) SetIntervalInSeconds(v int64) *AmazonOpenSearchServerlessBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *AmazonOpenSearchServerlessBufferingHints) SetSizeInMBs(v int64) *AmazonOpenSearchServerlessBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s AmazonOpenSearchServerlessBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonOpenSearchServerlessDestinationConfiguration struct { // The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints // are used. BufferingHints *AmazonOpenSearchServerlessBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the collection in the Serverless // offering for Amazon OpenSearch Service. CollectionEndpoint *string `min:"1" type:"string"` // The Serverless offering for Amazon OpenSearch Service index name. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to the // Serverless offering for Amazon OpenSearch Service. The default value is 300 // (5 minutes). RetryOptions *AmazonOpenSearchServerlessRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Serverless offering for Amazon OpenSearch Service Configuration // API and for indexing documents. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // Defines how documents should be delivered to Amazon S3. When it is set to // FailedDocumentsOnly, Firehose writes any documents that could not be indexed // to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ // appended to the key prefix. When set to AllDocuments, Firehose delivers all // incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ // appended to the prefix. S3BackupMode *string `type:"string" enum:"AmazonOpenSearchServerlessS3BackupMode"` // Describes the configuration of a destination in Amazon S3. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless // destination. VpcConfiguration *VpcConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
func (s AmazonOpenSearchServerlessDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetBufferingHints(v *AmazonOpenSearchServerlessBufferingHints) *AmazonOpenSearchServerlessDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonOpenSearchServerlessDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetCollectionEndpoint(v string) *AmazonOpenSearchServerlessDestinationConfiguration
SetCollectionEndpoint sets the CollectionEndpoint field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetIndexName(v string) *AmazonOpenSearchServerlessDestinationConfiguration
SetIndexName sets the IndexName field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonOpenSearchServerlessDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetRetryOptions(v *AmazonOpenSearchServerlessRetryOptions) *AmazonOpenSearchServerlessDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetRoleARN(v string) *AmazonOpenSearchServerlessDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetS3BackupMode(v string) *AmazonOpenSearchServerlessDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *AmazonOpenSearchServerlessDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *AmazonOpenSearchServerlessDestinationConfiguration) SetVpcConfiguration(v *VpcConfiguration) *AmazonOpenSearchServerlessDestinationConfiguration
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s AmazonOpenSearchServerlessDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonOpenSearchServerlessDestinationDescription struct { // The buffering options. BufferingHints *AmazonOpenSearchServerlessBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the collection in the Serverless // offering for Amazon OpenSearch Service. CollectionEndpoint *string `min:"1" type:"string"` // The Serverless offering for Amazon OpenSearch Service index name. IndexName *string `min:"1" type:"string"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Serverless offering for Amazon OpenSearch Service retry options. RetryOptions *AmazonOpenSearchServerlessRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. RoleARN *string `min:"1" type:"string"` // The Amazon S3 backup mode. S3BackupMode *string `type:"string" enum:"AmazonOpenSearchServerlessS3BackupMode"` // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // The details of the VPC of the Amazon ES destination. VpcConfigurationDescription *VpcConfigurationDescription `type:"structure"` // contains filtered or unexported fields }
The destination description in the Serverless offering for Amazon OpenSearch Service.
func (s AmazonOpenSearchServerlessDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessDestinationDescription) SetBufferingHints(v *AmazonOpenSearchServerlessBufferingHints) *AmazonOpenSearchServerlessDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonOpenSearchServerlessDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetCollectionEndpoint(v string) *AmazonOpenSearchServerlessDestinationDescription
SetCollectionEndpoint sets the CollectionEndpoint field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetIndexName(v string) *AmazonOpenSearchServerlessDestinationDescription
SetIndexName sets the IndexName field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonOpenSearchServerlessDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetRetryOptions(v *AmazonOpenSearchServerlessRetryOptions) *AmazonOpenSearchServerlessDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetRoleARN(v string) *AmazonOpenSearchServerlessDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetS3BackupMode(v string) *AmazonOpenSearchServerlessDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *AmazonOpenSearchServerlessDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *AmazonOpenSearchServerlessDestinationDescription) SetVpcConfigurationDescription(v *VpcConfigurationDescription) *AmazonOpenSearchServerlessDestinationDescription
SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.
func (s AmazonOpenSearchServerlessDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AmazonOpenSearchServerlessDestinationUpdate struct { // The buffering options. If no value is specified, AmazonopensearchBufferingHints // object default values are used. BufferingHints *AmazonOpenSearchServerlessBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the collection in the Serverless // offering for Amazon OpenSearch Service. CollectionEndpoint *string `min:"1" type:"string"` // The Serverless offering for Amazon OpenSearch Service index name. IndexName *string `min:"1" type:"string"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to the // Serverless offering for Amazon OpenSearch Service. The default value is 300 // (5 minutes). RetryOptions *AmazonOpenSearchServerlessRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Serverless offering for Amazon OpenSearch Service Configuration // API and for indexing documents. RoleARN *string `min:"1" type:"string"` // Describes an update for a destination in Amazon S3. S3Update *S3DestinationUpdate `type:"structure"` // contains filtered or unexported fields }
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
func (s AmazonOpenSearchServerlessDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetBufferingHints(v *AmazonOpenSearchServerlessBufferingHints) *AmazonOpenSearchServerlessDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonOpenSearchServerlessDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetCollectionEndpoint(v string) *AmazonOpenSearchServerlessDestinationUpdate
SetCollectionEndpoint sets the CollectionEndpoint field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetIndexName(v string) *AmazonOpenSearchServerlessDestinationUpdate
SetIndexName sets the IndexName field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonOpenSearchServerlessDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetRetryOptions(v *AmazonOpenSearchServerlessRetryOptions) *AmazonOpenSearchServerlessDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetRoleARN(v string) *AmazonOpenSearchServerlessDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *AmazonOpenSearchServerlessDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *AmazonOpenSearchServerlessDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s AmazonOpenSearchServerlessDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonOpenSearchServerlessRetryOptions struct { // After an initial failure to deliver to the Serverless offering for Amazon // OpenSearch Service, the total amount of time during which Firehose retries // delivery (including the first attempt). After this time has elapsed, the // failed documents are written to Amazon S3. Default value is 300 seconds (5 // minutes). A value of 0 (zero) results in no retries. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
func (s AmazonOpenSearchServerlessRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonOpenSearchServerlessRetryOptions) SetDurationInSeconds(v int64) *AmazonOpenSearchServerlessRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s AmazonOpenSearchServerlessRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AmazonopensearchserviceBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300 (5 minutes). IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 5. // // We recommend setting this parameter to a value greater than the amount of // data you typically ingest into the delivery stream in 10 seconds. For example, // if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
func (s AmazonopensearchserviceBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceBufferingHints) SetIntervalInSeconds(v int64) *AmazonopensearchserviceBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *AmazonopensearchserviceBufferingHints) SetSizeInMBs(v int64) *AmazonopensearchserviceBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s AmazonopensearchserviceBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonopensearchserviceDestinationConfiguration struct { // The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints // are used. BufferingHints *AmazonopensearchserviceBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Specify either this // ClusterEndpoint or the DomainARN field. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions // for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig // after assuming the role specified in RoleARN. DomainARN *string `min:"1" type:"string"` // The ElasticsearAmazon OpenSearch Service index name. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` // The Amazon OpenSearch Service index rotation period. Index rotation appends // a timestamp to the IndexName to facilitate the expiration of old data. IndexRotationPeriod *string `type:"string" enum:"AmazonopensearchserviceIndexRotationPeriod"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // OpenSearch Service. The default value is 300 (5 minutes). RetryOptions *AmazonopensearchserviceRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Amazon OpenSearch Service Configuration API and for indexing // documents. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // Defines how documents should be delivered to Amazon S3. When it is set to // FailedDocumentsOnly, Firehose writes any documents that could not be indexed // to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ // appended to the key prefix. When set to AllDocuments, Firehose delivers all // incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ // appended to the prefix. S3BackupMode *string `type:"string" enum:"AmazonopensearchserviceS3BackupMode"` // Describes the configuration of a destination in Amazon S3. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can // be only one type per index. If you try to specify a new type for an existing // index that already has another type, Firehose returns an error during run // time. TypeName *string `type:"string"` // The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless // destination. VpcConfiguration *VpcConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the configuration of a destination in Amazon OpenSearch Service
func (s AmazonopensearchserviceDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceDestinationConfiguration) SetBufferingHints(v *AmazonopensearchserviceBufferingHints) *AmazonopensearchserviceDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonopensearchserviceDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetClusterEndpoint(v string) *AmazonopensearchserviceDestinationConfiguration
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetDocumentIdOptions(v *DocumentIdOptions) *AmazonopensearchserviceDestinationConfiguration
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetDomainARN(v string) *AmazonopensearchserviceDestinationConfiguration
SetDomainARN sets the DomainARN field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetIndexName(v string) *AmazonopensearchserviceDestinationConfiguration
SetIndexName sets the IndexName field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetIndexRotationPeriod(v string) *AmazonopensearchserviceDestinationConfiguration
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonopensearchserviceDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetRetryOptions(v *AmazonopensearchserviceRetryOptions) *AmazonopensearchserviceDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetRoleARN(v string) *AmazonopensearchserviceDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetS3BackupMode(v string) *AmazonopensearchserviceDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *AmazonopensearchserviceDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetTypeName(v string) *AmazonopensearchserviceDestinationConfiguration
SetTypeName sets the TypeName field's value.
func (s *AmazonopensearchserviceDestinationConfiguration) SetVpcConfiguration(v *VpcConfiguration) *AmazonopensearchserviceDestinationConfiguration
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s AmazonopensearchserviceDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonopensearchserviceDestinationDescription struct { // The buffering options. BufferingHints *AmazonopensearchserviceBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Firehose uses either // this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch // Service. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon OpenSearch Service domain. DomainARN *string `min:"1" type:"string"` // The Amazon OpenSearch Service index name. IndexName *string `min:"1" type:"string"` // The Amazon OpenSearch Service index rotation period IndexRotationPeriod *string `type:"string" enum:"AmazonopensearchserviceIndexRotationPeriod"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Amazon OpenSearch Service retry options. RetryOptions *AmazonopensearchserviceRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. RoleARN *string `min:"1" type:"string"` // The Amazon S3 backup mode. S3BackupMode *string `type:"string" enum:"AmazonopensearchserviceS3BackupMode"` // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x // and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's // no value for TypeName. TypeName *string `type:"string"` // The details of the VPC of the Amazon ES destination. VpcConfigurationDescription *VpcConfigurationDescription `type:"structure"` // contains filtered or unexported fields }
The destination description in Amazon OpenSearch Service.
func (s AmazonopensearchserviceDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceDestinationDescription) SetBufferingHints(v *AmazonopensearchserviceBufferingHints) *AmazonopensearchserviceDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonopensearchserviceDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetClusterEndpoint(v string) *AmazonopensearchserviceDestinationDescription
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetDocumentIdOptions(v *DocumentIdOptions) *AmazonopensearchserviceDestinationDescription
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetDomainARN(v string) *AmazonopensearchserviceDestinationDescription
SetDomainARN sets the DomainARN field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetIndexName(v string) *AmazonopensearchserviceDestinationDescription
SetIndexName sets the IndexName field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetIndexRotationPeriod(v string) *AmazonopensearchserviceDestinationDescription
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonopensearchserviceDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetRetryOptions(v *AmazonopensearchserviceRetryOptions) *AmazonopensearchserviceDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetRoleARN(v string) *AmazonopensearchserviceDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetS3BackupMode(v string) *AmazonopensearchserviceDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *AmazonopensearchserviceDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetTypeName(v string) *AmazonopensearchserviceDestinationDescription
SetTypeName sets the TypeName field's value.
func (s *AmazonopensearchserviceDestinationDescription) SetVpcConfigurationDescription(v *VpcConfigurationDescription) *AmazonopensearchserviceDestinationDescription
SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.
func (s AmazonopensearchserviceDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AmazonopensearchserviceDestinationUpdate struct { // The buffering options. If no value is specified, AmazonopensearchBufferingHints // object default values are used. BufferingHints *AmazonopensearchserviceBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Specify either this // ClusterEndpoint or the DomainARN field. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions // for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming // the IAM role specified in RoleARN. DomainARN *string `min:"1" type:"string"` // The Amazon OpenSearch Service index name. IndexName *string `min:"1" type:"string"` // The Amazon OpenSearch Service index rotation period. Index rotation appends // a timestamp to IndexName to facilitate the expiration of old data. IndexRotationPeriod *string `type:"string" enum:"AmazonopensearchserviceIndexRotationPeriod"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // OpenSearch Service. The default value is 300 (5 minutes). RetryOptions *AmazonopensearchserviceRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Amazon OpenSearch Service Configuration API and for indexing // documents. RoleARN *string `min:"1" type:"string"` // Describes an update for a destination in Amazon S3. S3Update *S3DestinationUpdate `type:"structure"` // The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can // be only one type per index. If you try to specify a new type for an existing // index that already has another type, Firehose returns an error during runtime. // // If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery // stream, Firehose still delivers data to Elasticsearch with the old index // name and type name. If you want to update your delivery stream with a new // index name, provide an empty string for TypeName. TypeName *string `type:"string"` // contains filtered or unexported fields }
Describes an update for a destination in Amazon OpenSearch Service.
func (s AmazonopensearchserviceDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceDestinationUpdate) SetBufferingHints(v *AmazonopensearchserviceBufferingHints) *AmazonopensearchserviceDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *AmazonopensearchserviceDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetClusterEndpoint(v string) *AmazonopensearchserviceDestinationUpdate
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetDocumentIdOptions(v *DocumentIdOptions) *AmazonopensearchserviceDestinationUpdate
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetDomainARN(v string) *AmazonopensearchserviceDestinationUpdate
SetDomainARN sets the DomainARN field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetIndexName(v string) *AmazonopensearchserviceDestinationUpdate
SetIndexName sets the IndexName field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetIndexRotationPeriod(v string) *AmazonopensearchserviceDestinationUpdate
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *AmazonopensearchserviceDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetRetryOptions(v *AmazonopensearchserviceRetryOptions) *AmazonopensearchserviceDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetRoleARN(v string) *AmazonopensearchserviceDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *AmazonopensearchserviceDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *AmazonopensearchserviceDestinationUpdate) SetTypeName(v string) *AmazonopensearchserviceDestinationUpdate
SetTypeName sets the TypeName field's value.
func (s AmazonopensearchserviceDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AmazonopensearchserviceRetryOptions struct { // After an initial failure to deliver to Amazon OpenSearch Service, the total // amount of time during which Firehose retries delivery (including the first // attempt). After this time has elapsed, the failed documents are written to // Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) // results in no retries. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
func (s AmazonopensearchserviceRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AmazonopensearchserviceRetryOptions) SetDurationInSeconds(v int64) *AmazonopensearchserviceRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s AmazonopensearchserviceRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AuthenticationConfiguration struct { // The type of connectivity used to access the Amazon MSK cluster. // // Connectivity is a required field Connectivity *string `type:"string" required:"true" enum:"Connectivity"` // The ARN of the role used to access the Amazon MSK cluster. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The authentication configuration of the Amazon MSK cluster.
func (s AuthenticationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthenticationConfiguration) SetConnectivity(v string) *AuthenticationConfiguration
SetConnectivity sets the Connectivity field's value.
func (s *AuthenticationConfiguration) SetRoleARN(v string) *AuthenticationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s AuthenticationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthenticationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300. This parameter // is optional but if you specify a value for it, you must also specify a value // for SizeInMBs, and vice versa. IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MiBs, before delivering it // to the destination. The default value is 5. This parameter is optional but // if you specify a value for it, you must also specify a value for IntervalInSeconds, // and vice versa. // // We recommend setting this parameter to a value greater than the amount of // data you typically ingest into the delivery stream in 10 seconds. For example, // if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or // higher. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
func (s BufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BufferingHints) SetIntervalInSeconds(v int64) *BufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *BufferingHints) SetSizeInMBs(v int64) *BufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s BufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CatalogConfiguration struct { // Specifies the Glue catalog ARN indentifier of the destination Apache Iceberg // Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog. // // Amazon Data Firehose is in preview release and is subject to change. CatalogARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the containers where the destination Apache Iceberg Tables are persisted.
Amazon Data Firehose is in preview release and is subject to change.
func (s CatalogConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CatalogConfiguration) SetCatalogARN(v string) *CatalogConfiguration
SetCatalogARN sets the CatalogARN field's value.
func (s CatalogConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CatalogConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CloudWatchLoggingOptions struct { // Enables or disables CloudWatch logging. Enabled *bool `type:"boolean"` // The CloudWatch group name for logging. This value is required if CloudWatch // logging is enabled. LogGroupName *string `type:"string"` // The CloudWatch log stream name for logging. This value is required if CloudWatch // logging is enabled. LogStreamName *string `type:"string"` // contains filtered or unexported fields }
Describes the Amazon CloudWatch logging options for your delivery stream.
func (s CloudWatchLoggingOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudWatchLoggingOptions) SetEnabled(v bool) *CloudWatchLoggingOptions
SetEnabled sets the Enabled field's value.
func (s *CloudWatchLoggingOptions) SetLogGroupName(v string) *CloudWatchLoggingOptions
SetLogGroupName sets the LogGroupName field's value.
func (s *CloudWatchLoggingOptions) SetLogStreamName(v string) *CloudWatchLoggingOptions
SetLogStreamName sets the LogStreamName field's value.
func (s CloudWatchLoggingOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConcurrentModificationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Another modification has already happened. Fetch VersionId again and use it to update the destination.
func (s *ConcurrentModificationException) Code() string
Code returns the exception type name.
func (s *ConcurrentModificationException) Error() string
func (s ConcurrentModificationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConcurrentModificationException) Message() string
Message returns the exception's message.
func (s *ConcurrentModificationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConcurrentModificationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConcurrentModificationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConcurrentModificationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CopyCommand struct { // Optional parameters to use with the Amazon Redshift COPY command. For more // information, see the "Optional Parameters" section of Amazon Redshift COPY // command (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html). Some // possible examples that would apply to Firehose are as follows: // // delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and // compressed using lzop. // // delimiter '|' - fields are delimited with "|" (this is the default delimiter). // // delimiter '|' escape - the delimiter should be escaped. // // fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' // - fields are fixed width in the source, with each width specified after every // column in the table. // // JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path // specified is the format of the data. // // For more examples, see Amazon Redshift COPY command examples (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html). CopyOptions *string `type:"string"` // A comma-separated list of column names. DataTableColumns *string `type:"string"` // The name of the target table. The table must already exist in the database. // // DataTableName is a required field DataTableName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes a COPY command for Amazon Redshift.
func (s CopyCommand) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CopyCommand) SetCopyOptions(v string) *CopyCommand
SetCopyOptions sets the CopyOptions field's value.
func (s *CopyCommand) SetDataTableColumns(v string) *CopyCommand
SetDataTableColumns sets the DataTableColumns field's value.
func (s *CopyCommand) SetDataTableName(v string) *CopyCommand
SetDataTableName sets the DataTableName field's value.
func (s CopyCommand) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CopyCommand) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeliveryStreamInput struct { // The destination in the Serverless offering for Amazon OpenSearch Service. // You can specify only one destination. AmazonOpenSearchServerlessDestinationConfiguration *AmazonOpenSearchServerlessDestinationConfiguration `type:"structure"` // The destination in Amazon OpenSearch Service. You can specify only one destination. AmazonopensearchserviceDestinationConfiguration *AmazonopensearchserviceDestinationConfiguration `type:"structure"` // Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed // for Server-Side Encryption (SSE). DeliveryStreamEncryptionConfigurationInput *DeliveryStreamEncryptionConfigurationInput `type:"structure"` // The name of the delivery stream. This name must be unique per Amazon Web // Services account in the same Amazon Web Services Region. If the delivery // streams are in different accounts or different Regions, you can have multiple // delivery streams with the same name. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The delivery stream type. This parameter can be one of the following values: // // * DirectPut: Provider applications access the delivery stream directly. // // * KinesisStreamAsSource: The delivery stream uses a Kinesis data stream // as a source. DeliveryStreamType *string `type:"string" enum:"DeliveryStreamType"` // The destination in Amazon ES. You can specify only one destination. ElasticsearchDestinationConfiguration *ElasticsearchDestinationConfiguration `type:"structure"` // The destination in Amazon S3. You can specify only one destination. ExtendedS3DestinationConfiguration *ExtendedS3DestinationConfiguration `type:"structure"` // Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint // destination. You can specify only one destination. HttpEndpointDestinationConfiguration *HttpEndpointDestinationConfiguration `type:"structure"` // Configure Apache Iceberg Tables destination. // // Amazon Data Firehose is in preview release and is subject to change. IcebergDestinationConfiguration *IcebergDestinationConfiguration `type:"structure"` // When a Kinesis data stream is used as the source for the delivery stream, // a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon // Resource Name (ARN) and the role ARN for the source stream. KinesisStreamSourceConfiguration *KinesisStreamSourceConfiguration `type:"structure"` // The configuration for the Amazon MSK cluster to be used as the source for // a delivery stream. MSKSourceConfiguration *MSKSourceConfiguration `type:"structure"` // The destination in Amazon Redshift. You can specify only one destination. RedshiftDestinationConfiguration *RedshiftDestinationConfiguration `type:"structure"` // [Deprecated] The destination in Amazon S3. You can specify only one destination. // // Deprecated: S3DestinationConfiguration has been deprecated S3DestinationConfiguration *S3DestinationConfiguration `deprecated:"true" type:"structure"` // Configure Snowflake destination SnowflakeDestinationConfiguration *SnowflakeDestinationConfiguration `type:"structure"` // The destination in Splunk. You can specify only one destination. SplunkDestinationConfiguration *SplunkDestinationConfiguration `type:"structure"` // A set of tags to assign to the delivery stream. A tag is a key-value pair // that you can define and assign to Amazon Web Services resources. Tags are // metadata. For example, you can add friendly names and descriptions or other // types of information that can help you distinguish the delivery stream. For // more information about tags, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide. // // You can specify up to 50 tags when creating a delivery stream. // // If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose // performs an additional authorization on the firehose:TagDeliveryStream action // to verify if users have permissions to create tags. If you do not provide // this permission, requests to create new Firehose delivery streams with IAM // resource tags will fail with an AccessDeniedException such as following. // // AccessDeniedException // // User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream // on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit // deny in an identity-based policy. // // For an example IAM policy, see Tag example. (https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples) Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s CreateDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDeliveryStreamInput) SetAmazonOpenSearchServerlessDestinationConfiguration(v *AmazonOpenSearchServerlessDestinationConfiguration) *CreateDeliveryStreamInput
SetAmazonOpenSearchServerlessDestinationConfiguration sets the AmazonOpenSearchServerlessDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetAmazonopensearchserviceDestinationConfiguration(v *AmazonopensearchserviceDestinationConfiguration) *CreateDeliveryStreamInput
SetAmazonopensearchserviceDestinationConfiguration sets the AmazonopensearchserviceDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetDeliveryStreamEncryptionConfigurationInput(v *DeliveryStreamEncryptionConfigurationInput) *CreateDeliveryStreamInput
SetDeliveryStreamEncryptionConfigurationInput sets the DeliveryStreamEncryptionConfigurationInput field's value.
func (s *CreateDeliveryStreamInput) SetDeliveryStreamName(v string) *CreateDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *CreateDeliveryStreamInput) SetDeliveryStreamType(v string) *CreateDeliveryStreamInput
SetDeliveryStreamType sets the DeliveryStreamType field's value.
func (s *CreateDeliveryStreamInput) SetElasticsearchDestinationConfiguration(v *ElasticsearchDestinationConfiguration) *CreateDeliveryStreamInput
SetElasticsearchDestinationConfiguration sets the ElasticsearchDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetExtendedS3DestinationConfiguration(v *ExtendedS3DestinationConfiguration) *CreateDeliveryStreamInput
SetExtendedS3DestinationConfiguration sets the ExtendedS3DestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetHttpEndpointDestinationConfiguration(v *HttpEndpointDestinationConfiguration) *CreateDeliveryStreamInput
SetHttpEndpointDestinationConfiguration sets the HttpEndpointDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetIcebergDestinationConfiguration(v *IcebergDestinationConfiguration) *CreateDeliveryStreamInput
SetIcebergDestinationConfiguration sets the IcebergDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetKinesisStreamSourceConfiguration(v *KinesisStreamSourceConfiguration) *CreateDeliveryStreamInput
SetKinesisStreamSourceConfiguration sets the KinesisStreamSourceConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetMSKSourceConfiguration(v *MSKSourceConfiguration) *CreateDeliveryStreamInput
SetMSKSourceConfiguration sets the MSKSourceConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetRedshiftDestinationConfiguration(v *RedshiftDestinationConfiguration) *CreateDeliveryStreamInput
SetRedshiftDestinationConfiguration sets the RedshiftDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetS3DestinationConfiguration(v *S3DestinationConfiguration) *CreateDeliveryStreamInput
SetS3DestinationConfiguration sets the S3DestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetSnowflakeDestinationConfiguration(v *SnowflakeDestinationConfiguration) *CreateDeliveryStreamInput
SetSnowflakeDestinationConfiguration sets the SnowflakeDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetSplunkDestinationConfiguration(v *SplunkDestinationConfiguration) *CreateDeliveryStreamInput
SetSplunkDestinationConfiguration sets the SplunkDestinationConfiguration field's value.
func (s *CreateDeliveryStreamInput) SetTags(v []*Tag) *CreateDeliveryStreamInput
SetTags sets the Tags field's value.
func (s CreateDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeliveryStreamOutput struct { // The ARN of the delivery stream. DeliveryStreamARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s CreateDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDeliveryStreamOutput) SetDeliveryStreamARN(v string) *CreateDeliveryStreamOutput
SetDeliveryStreamARN sets the DeliveryStreamARN field's value.
func (s CreateDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DataFormatConversionConfiguration struct { // Defaults to true. Set it to false if you want to disable format conversion // while preserving the configuration details. Enabled *bool `type:"boolean"` // Specifies the deserializer that you want Firehose to use to convert the format // of your data from JSON. This parameter is required if Enabled is set to true. InputFormatConfiguration *InputFormatConfiguration `type:"structure"` // Specifies the serializer that you want Firehose to use to convert the format // of your data to the Parquet or ORC format. This parameter is required if // Enabled is set to true. OutputFormatConfiguration *OutputFormatConfiguration `type:"structure"` // Specifies the Amazon Web Services Glue Data Catalog table that contains the // column information. This parameter is required if Enabled is set to true. SchemaConfiguration *SchemaConfiguration `type:"structure"` // contains filtered or unexported fields }
Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Firehose Record Format Conversion (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html).
func (s DataFormatConversionConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DataFormatConversionConfiguration) SetEnabled(v bool) *DataFormatConversionConfiguration
SetEnabled sets the Enabled field's value.
func (s *DataFormatConversionConfiguration) SetInputFormatConfiguration(v *InputFormatConfiguration) *DataFormatConversionConfiguration
SetInputFormatConfiguration sets the InputFormatConfiguration field's value.
func (s *DataFormatConversionConfiguration) SetOutputFormatConfiguration(v *OutputFormatConfiguration) *DataFormatConversionConfiguration
SetOutputFormatConfiguration sets the OutputFormatConfiguration field's value.
func (s *DataFormatConversionConfiguration) SetSchemaConfiguration(v *SchemaConfiguration) *DataFormatConversionConfiguration
SetSchemaConfiguration sets the SchemaConfiguration field's value.
func (s DataFormatConversionConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DataFormatConversionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDeliveryStreamInput struct { // Set this to true if you want to delete the delivery stream even if Firehose // is unable to retire the grant for the CMK. Firehose might be unable to retire // the grant due to a customer error, such as when the CMK or the grant are // in an invalid state. If you force deletion, you can then use the RevokeGrant // (https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) // operation to revoke the grant you gave to Firehose. If a failure to retire // the grant happens due to an Amazon Web Services KMS issue, Firehose keeps // retrying the delete operation. // // The default value is false. AllowForceDelete *bool `type:"boolean"` // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDeliveryStreamInput) SetAllowForceDelete(v bool) *DeleteDeliveryStreamInput
SetAllowForceDelete sets the AllowForceDelete field's value.
func (s *DeleteDeliveryStreamInput) SetDeliveryStreamName(v string) *DeleteDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s DeleteDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDeliveryStreamOutput struct {
// contains filtered or unexported fields
}
func (s DeleteDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeliveryStreamDescription struct { // The date and time that the delivery stream was created. CreateTimestamp *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the delivery stream. For more information, // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // DeliveryStreamARN is a required field DeliveryStreamARN *string `min:"1" type:"string" required:"true"` // Indicates the server-side encryption (SSE) status for the delivery stream. DeliveryStreamEncryptionConfiguration *DeliveryStreamEncryptionConfiguration `type:"structure"` // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The status of the delivery stream. If the status of a delivery stream is // CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream // again on it. However, you can invoke the DeleteDeliveryStream operation to // delete it. // // DeliveryStreamStatus is a required field DeliveryStreamStatus *string `type:"string" required:"true" enum:"DeliveryStreamStatus"` // The delivery stream type. This can be one of the following values: // // * DirectPut: Provider applications access the delivery stream directly. // // * KinesisStreamAsSource: The delivery stream uses a Kinesis data stream // as a source. // // DeliveryStreamType is a required field DeliveryStreamType *string `type:"string" required:"true" enum:"DeliveryStreamType"` // The destinations. // // Destinations is a required field Destinations []*DestinationDescription `type:"list" required:"true"` // Provides details in case one of the following operations fails due to an // error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, // StopDeliveryStreamEncryption. FailureDescription *FailureDescription `type:"structure"` // Indicates whether there are more destinations available to list. // // HasMoreDestinations is a required field HasMoreDestinations *bool `type:"boolean" required:"true"` // The date and time that the delivery stream was last updated. LastUpdateTimestamp *time.Time `type:"timestamp"` // If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription // object describing the source Kinesis data stream. Source *SourceDescription `type:"structure"` // Each time the destination is updated for a delivery stream, the version ID // is changed, and the current version ID is required when updating the destination. // This is so that the service knows it is applying the changes to the correct // version of the delivery stream. // // VersionId is a required field VersionId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information about a delivery stream.
func (s DeliveryStreamDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeliveryStreamDescription) SetCreateTimestamp(v time.Time) *DeliveryStreamDescription
SetCreateTimestamp sets the CreateTimestamp field's value.
func (s *DeliveryStreamDescription) SetDeliveryStreamARN(v string) *DeliveryStreamDescription
SetDeliveryStreamARN sets the DeliveryStreamARN field's value.
func (s *DeliveryStreamDescription) SetDeliveryStreamEncryptionConfiguration(v *DeliveryStreamEncryptionConfiguration) *DeliveryStreamDescription
SetDeliveryStreamEncryptionConfiguration sets the DeliveryStreamEncryptionConfiguration field's value.
func (s *DeliveryStreamDescription) SetDeliveryStreamName(v string) *DeliveryStreamDescription
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *DeliveryStreamDescription) SetDeliveryStreamStatus(v string) *DeliveryStreamDescription
SetDeliveryStreamStatus sets the DeliveryStreamStatus field's value.
func (s *DeliveryStreamDescription) SetDeliveryStreamType(v string) *DeliveryStreamDescription
SetDeliveryStreamType sets the DeliveryStreamType field's value.
func (s *DeliveryStreamDescription) SetDestinations(v []*DestinationDescription) *DeliveryStreamDescription
SetDestinations sets the Destinations field's value.
func (s *DeliveryStreamDescription) SetFailureDescription(v *FailureDescription) *DeliveryStreamDescription
SetFailureDescription sets the FailureDescription field's value.
func (s *DeliveryStreamDescription) SetHasMoreDestinations(v bool) *DeliveryStreamDescription
SetHasMoreDestinations sets the HasMoreDestinations field's value.
func (s *DeliveryStreamDescription) SetLastUpdateTimestamp(v time.Time) *DeliveryStreamDescription
SetLastUpdateTimestamp sets the LastUpdateTimestamp field's value.
func (s *DeliveryStreamDescription) SetSource(v *SourceDescription) *DeliveryStreamDescription
SetSource sets the Source field's value.
func (s *DeliveryStreamDescription) SetVersionId(v string) *DeliveryStreamDescription
SetVersionId sets the VersionId field's value.
func (s DeliveryStreamDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeliveryStreamEncryptionConfiguration struct { // Provides details in case one of the following operations fails due to an // error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, // StopDeliveryStreamEncryption. FailureDescription *FailureDescription `type:"structure"` // If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer // managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration // doesn't contain a value for KeyARN. KeyARN *string `min:"1" type:"string"` // Indicates the type of customer master key (CMK) that is used for encryption. // The default setting is Amazon Web Services_OWNED_CMK. For more information // about CMKs, see Customer Master Keys (CMKs) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). KeyType *string `type:"string" enum:"KeyType"` // This is the server-side encryption (SSE) status for the delivery stream. // For a full description of the different values of this status, see StartDeliveryStreamEncryption // and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, // it is the status of the most recent attempt to enable or disable SSE, respectively. Status *string `type:"string" enum:"DeliveryStreamEncryptionStatus"` // contains filtered or unexported fields }
Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.
func (s DeliveryStreamEncryptionConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeliveryStreamEncryptionConfiguration) SetFailureDescription(v *FailureDescription) *DeliveryStreamEncryptionConfiguration
SetFailureDescription sets the FailureDescription field's value.
func (s *DeliveryStreamEncryptionConfiguration) SetKeyARN(v string) *DeliveryStreamEncryptionConfiguration
SetKeyARN sets the KeyARN field's value.
func (s *DeliveryStreamEncryptionConfiguration) SetKeyType(v string) *DeliveryStreamEncryptionConfiguration
SetKeyType sets the KeyType field's value.
func (s *DeliveryStreamEncryptionConfiguration) SetStatus(v string) *DeliveryStreamEncryptionConfiguration
SetStatus sets the Status field's value.
func (s DeliveryStreamEncryptionConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeliveryStreamEncryptionConfigurationInput struct { // If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource // Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, // Firehose uses a service-account CMK. KeyARN *string `min:"1" type:"string"` // Indicates the type of customer master key (CMK) to use for encryption. The // default setting is Amazon Web Services_OWNED_CMK. For more information about // CMKs, see Customer Master Keys (CMKs) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). // When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with // KeyType set to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation // CreateGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) // to create a grant that allows the Firehose service to use the customer managed // CMK to perform encryption and decryption. Firehose manages that grant. // // When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery // stream that is encrypted with a customer managed CMK, Firehose schedules // the grant it had on the old CMK for retirement. // // You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery // streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation // exceeds this limit, Firehose throws a LimitExceededException. // // To encrypt your delivery stream, use symmetric CMKs. Firehose doesn't support // asymmetric CMKs. For information about symmetric and asymmetric CMKs, see // About Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) // in the Amazon Web Services Key Management Service developer guide. // // KeyType is a required field KeyType *string `type:"string" required:"true" enum:"KeyType"` // contains filtered or unexported fields }
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
func (s DeliveryStreamEncryptionConfigurationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeliveryStreamEncryptionConfigurationInput) SetKeyARN(v string) *DeliveryStreamEncryptionConfigurationInput
SetKeyARN sets the KeyARN field's value.
func (s *DeliveryStreamEncryptionConfigurationInput) SetKeyType(v string) *DeliveryStreamEncryptionConfigurationInput
SetKeyType sets the KeyType field's value.
func (s DeliveryStreamEncryptionConfigurationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeliveryStreamEncryptionConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDeliveryStreamInput struct { // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The ID of the destination to start returning the destination information. // Firehose supports one destination per delivery stream. ExclusiveStartDestinationId *string `min:"1" type:"string"` // The limit on the number of destinations to return. You can have one destination // per delivery stream. Limit *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
func (s DescribeDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeliveryStreamInput) SetDeliveryStreamName(v string) *DescribeDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *DescribeDeliveryStreamInput) SetExclusiveStartDestinationId(v string) *DescribeDeliveryStreamInput
SetExclusiveStartDestinationId sets the ExclusiveStartDestinationId field's value.
func (s *DescribeDeliveryStreamInput) SetLimit(v int64) *DescribeDeliveryStreamInput
SetLimit sets the Limit field's value.
func (s DescribeDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDeliveryStreamOutput struct { // Information about the delivery stream. // // DeliveryStreamDescription is a required field DeliveryStreamDescription *DeliveryStreamDescription `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeliveryStreamOutput) SetDeliveryStreamDescription(v *DeliveryStreamDescription) *DescribeDeliveryStreamOutput
SetDeliveryStreamDescription sets the DeliveryStreamDescription field's value.
func (s DescribeDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Deserializer struct { // The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing // data, which means converting it from the JSON format in preparation for serializing // it to the Parquet or ORC format. This is one of two deserializers you can // choose, depending on which one offers the functionality you need. The other // option is the OpenX SerDe. HiveJsonSerDe *HiveJsonSerDe `type:"structure"` // The OpenX SerDe. Used by Firehose for deserializing data, which means converting // it from the JSON format in preparation for serializing it to the Parquet // or ORC format. This is one of two deserializers you can choose, depending // on which one offers the functionality you need. The other option is the native // Hive / HCatalog JsonSerDe. OpenXJsonSerDe *OpenXJsonSerDe `type:"structure"` // contains filtered or unexported fields }
The deserializer you want Firehose to use for converting the input data from JSON. Firehose then serializes the data to its final format using the Serializer. Firehose supports two types of deserializers: the Apache Hive JSON SerDe (https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) and the OpenX JSON SerDe (https://github.com/rcongiu/Hive-JSON-Serde).
func (s Deserializer) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Deserializer) SetHiveJsonSerDe(v *HiveJsonSerDe) *Deserializer
SetHiveJsonSerDe sets the HiveJsonSerDe field's value.
func (s *Deserializer) SetOpenXJsonSerDe(v *OpenXJsonSerDe) *Deserializer
SetOpenXJsonSerDe sets the OpenXJsonSerDe field's value.
func (s Deserializer) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DestinationDescription struct { // The destination in the Serverless offering for Amazon OpenSearch Service. AmazonOpenSearchServerlessDestinationDescription *AmazonOpenSearchServerlessDestinationDescription `type:"structure"` // The destination in Amazon OpenSearch Service. AmazonopensearchserviceDestinationDescription *AmazonopensearchserviceDestinationDescription `type:"structure"` // The ID of the destination. // // DestinationId is a required field DestinationId *string `min:"1" type:"string" required:"true"` // The destination in Amazon ES. ElasticsearchDestinationDescription *ElasticsearchDestinationDescription `type:"structure"` // The destination in Amazon S3. ExtendedS3DestinationDescription *ExtendedS3DestinationDescription `type:"structure"` // Describes the specified HTTP endpoint destination. HttpEndpointDestinationDescription *HttpEndpointDestinationDescription `type:"structure"` // Describes a destination in Apache Iceberg Tables. // // Amazon Data Firehose is in preview release and is subject to change. IcebergDestinationDescription *IcebergDestinationDescription `type:"structure"` // The destination in Amazon Redshift. RedshiftDestinationDescription *RedshiftDestinationDescription `type:"structure"` // [Deprecated] The destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // Optional description for the destination SnowflakeDestinationDescription *SnowflakeDestinationDescription `type:"structure"` // The destination in Splunk. SplunkDestinationDescription *SplunkDestinationDescription `type:"structure"` // contains filtered or unexported fields }
Describes the destination for a delivery stream.
func (s DestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationDescription) SetAmazonOpenSearchServerlessDestinationDescription(v *AmazonOpenSearchServerlessDestinationDescription) *DestinationDescription
SetAmazonOpenSearchServerlessDestinationDescription sets the AmazonOpenSearchServerlessDestinationDescription field's value.
func (s *DestinationDescription) SetAmazonopensearchserviceDestinationDescription(v *AmazonopensearchserviceDestinationDescription) *DestinationDescription
SetAmazonopensearchserviceDestinationDescription sets the AmazonopensearchserviceDestinationDescription field's value.
func (s *DestinationDescription) SetDestinationId(v string) *DestinationDescription
SetDestinationId sets the DestinationId field's value.
func (s *DestinationDescription) SetElasticsearchDestinationDescription(v *ElasticsearchDestinationDescription) *DestinationDescription
SetElasticsearchDestinationDescription sets the ElasticsearchDestinationDescription field's value.
func (s *DestinationDescription) SetExtendedS3DestinationDescription(v *ExtendedS3DestinationDescription) *DestinationDescription
SetExtendedS3DestinationDescription sets the ExtendedS3DestinationDescription field's value.
func (s *DestinationDescription) SetHttpEndpointDestinationDescription(v *HttpEndpointDestinationDescription) *DestinationDescription
SetHttpEndpointDestinationDescription sets the HttpEndpointDestinationDescription field's value.
func (s *DestinationDescription) SetIcebergDestinationDescription(v *IcebergDestinationDescription) *DestinationDescription
SetIcebergDestinationDescription sets the IcebergDestinationDescription field's value.
func (s *DestinationDescription) SetRedshiftDestinationDescription(v *RedshiftDestinationDescription) *DestinationDescription
SetRedshiftDestinationDescription sets the RedshiftDestinationDescription field's value.
func (s *DestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *DestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *DestinationDescription) SetSnowflakeDestinationDescription(v *SnowflakeDestinationDescription) *DestinationDescription
SetSnowflakeDestinationDescription sets the SnowflakeDestinationDescription field's value.
func (s *DestinationDescription) SetSplunkDestinationDescription(v *SplunkDestinationDescription) *DestinationDescription
SetSplunkDestinationDescription sets the SplunkDestinationDescription field's value.
func (s DestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DestinationTableConfiguration struct { // The name of the Apache Iceberg database. // // Amazon Data Firehose is in preview release and is subject to change. // // DestinationDatabaseName is a required field DestinationDatabaseName *string `min:"1" type:"string" required:"true"` // Specifies the name of the Apache Iceberg Table. // // Amazon Data Firehose is in preview release and is subject to change. // // DestinationTableName is a required field DestinationTableName *string `min:"1" type:"string" required:"true"` // The table specific S3 error output prefix. All the errors that occurred while // delivering to this table will be prefixed with this value in S3 destination. // // Amazon Data Firehose is in preview release and is subject to change. S3ErrorOutputPrefix *string `type:"string"` // A list of unique keys for a given Apache Iceberg table. Firehose will use // these for running Create/Update/Delete operations on the given Iceberg table. // // Amazon Data Firehose is in preview release and is subject to change. UniqueKeys []*string `type:"list"` // contains filtered or unexported fields }
Describes the configuration of a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
func (s DestinationTableConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationTableConfiguration) SetDestinationDatabaseName(v string) *DestinationTableConfiguration
SetDestinationDatabaseName sets the DestinationDatabaseName field's value.
func (s *DestinationTableConfiguration) SetDestinationTableName(v string) *DestinationTableConfiguration
SetDestinationTableName sets the DestinationTableName field's value.
func (s *DestinationTableConfiguration) SetS3ErrorOutputPrefix(v string) *DestinationTableConfiguration
SetS3ErrorOutputPrefix sets the S3ErrorOutputPrefix field's value.
func (s *DestinationTableConfiguration) SetUniqueKeys(v []*string) *DestinationTableConfiguration
SetUniqueKeys sets the UniqueKeys field's value.
func (s DestinationTableConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationTableConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentIdOptions struct { // When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document // ID for each record based on a unique internal identifier. The generated document // ID is stable across multiple delivery attempts, which helps prevent the same // record from being indexed multiple times with different document IDs. // // When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document // IDs in the requests it sends to the Amazon OpenSearch Service. This causes // the Amazon OpenSearch Service domain to generate document IDs. In case of // multiple delivery attempts, this may cause the same record to be indexed // more than once with different document IDs. This option enables write-heavy // operations, such as the ingestion of logs and observability data, to consume // less resources in the Amazon OpenSearch Service domain, resulting in improved // performance. // // DefaultDocumentIdFormat is a required field DefaultDocumentIdFormat *string `type:"string" required:"true" enum:"DefaultDocumentIdFormat"` // contains filtered or unexported fields }
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
func (s DocumentIdOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentIdOptions) SetDefaultDocumentIdFormat(v string) *DocumentIdOptions
SetDefaultDocumentIdFormat sets the DefaultDocumentIdFormat field's value.
func (s DocumentIdOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentIdOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DynamicPartitioningConfiguration struct { // Specifies that the dynamic partitioning is enabled for this Firehose delivery // stream. Enabled *bool `type:"boolean"` // The retry behavior in case Firehose is unable to deliver data to an Amazon // S3 prefix. RetryOptions *RetryOptions `type:"structure"` // contains filtered or unexported fields }
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
func (s DynamicPartitioningConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DynamicPartitioningConfiguration) SetEnabled(v bool) *DynamicPartitioningConfiguration
SetEnabled sets the Enabled field's value.
func (s *DynamicPartitioningConfiguration) SetRetryOptions(v *RetryOptions) *DynamicPartitioningConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s DynamicPartitioningConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ElasticsearchBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300 (5 minutes). IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 5. // // We recommend setting this parameter to a value greater than the amount of // data you typically ingest into the delivery stream in 10 seconds. For example, // if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the buffering to perform before delivering data to the Amazon ES destination.
func (s ElasticsearchBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchBufferingHints) SetIntervalInSeconds(v int64) *ElasticsearchBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *ElasticsearchBufferingHints) SetSizeInMBs(v int64) *ElasticsearchBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s ElasticsearchBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ElasticsearchDestinationConfiguration struct { // The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints // are used. BufferingHints *ElasticsearchBufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Specify either this // ClusterEndpoint or the DomainARN field. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, // DescribeDomains, and DescribeDomainConfig after assuming the role specified // in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon // Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // Specify either ClusterEndpoint or DomainARN. DomainARN *string `min:"1" type:"string"` // The Elasticsearch index name. // // IndexName is a required field IndexName *string `min:"1" type:"string" required:"true"` // The Elasticsearch index rotation period. Index rotation appends a timestamp // to the IndexName to facilitate the expiration of old data. For more information, // see Index Rotation for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). // The default value is OneDay. IndexRotationPeriod *string `type:"string" enum:"ElasticsearchIndexRotationPeriod"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // ES. The default value is 300 (5 minutes). RetryOptions *ElasticsearchRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Amazon ES Configuration API and for indexing documents. For // more information, see Grant Firehose Access to an Amazon S3 Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // Defines how documents should be delivered to Amazon S3. When it is set to // FailedDocumentsOnly, Firehose writes any documents that could not be indexed // to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ // appended to the key prefix. When set to AllDocuments, Firehose delivers all // incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ // appended to the prefix. For more information, see Amazon S3 Backup for the // Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup). // Default value is FailedDocumentsOnly. // // You can't change this backup mode after you create the delivery stream. S3BackupMode *string `type:"string" enum:"ElasticsearchS3BackupMode"` // The configuration for the backup Amazon S3 location. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one // type per index. If you try to specify a new type for an existing index that // already has another type, Firehose returns an error during run time. // // For Elasticsearch 7.x, don't specify a TypeName. TypeName *string `type:"string"` // The details of the VPC of the Amazon destination. VpcConfiguration *VpcConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the configuration of a destination in Amazon ES.
func (s ElasticsearchDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchDestinationConfiguration) SetBufferingHints(v *ElasticsearchBufferingHints) *ElasticsearchDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *ElasticsearchDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ElasticsearchDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ElasticsearchDestinationConfiguration) SetClusterEndpoint(v string) *ElasticsearchDestinationConfiguration
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *ElasticsearchDestinationConfiguration) SetDocumentIdOptions(v *DocumentIdOptions) *ElasticsearchDestinationConfiguration
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *ElasticsearchDestinationConfiguration) SetDomainARN(v string) *ElasticsearchDestinationConfiguration
SetDomainARN sets the DomainARN field's value.
func (s *ElasticsearchDestinationConfiguration) SetIndexName(v string) *ElasticsearchDestinationConfiguration
SetIndexName sets the IndexName field's value.
func (s *ElasticsearchDestinationConfiguration) SetIndexRotationPeriod(v string) *ElasticsearchDestinationConfiguration
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *ElasticsearchDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *ElasticsearchDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ElasticsearchDestinationConfiguration) SetRetryOptions(v *ElasticsearchRetryOptions) *ElasticsearchDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *ElasticsearchDestinationConfiguration) SetRoleARN(v string) *ElasticsearchDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *ElasticsearchDestinationConfiguration) SetS3BackupMode(v string) *ElasticsearchDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *ElasticsearchDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *ElasticsearchDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *ElasticsearchDestinationConfiguration) SetTypeName(v string) *ElasticsearchDestinationConfiguration
SetTypeName sets the TypeName field's value.
func (s *ElasticsearchDestinationConfiguration) SetVpcConfiguration(v *VpcConfiguration) *ElasticsearchDestinationConfiguration
SetVpcConfiguration sets the VpcConfiguration field's value.
func (s ElasticsearchDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ElasticsearchDestinationDescription struct { // The buffering options. BufferingHints *ElasticsearchBufferingHints `type:"structure"` // The Amazon CloudWatch logging options. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Firehose uses either // this ClusterEndpoint or the DomainARN field to send data to Amazon ES. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon ES domain. For more information, see Amazon Resource // Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon // ES. DomainARN *string `min:"1" type:"string"` // The Elasticsearch index name. IndexName *string `min:"1" type:"string"` // The Elasticsearch index rotation period IndexRotationPeriod *string `type:"string" enum:"ElasticsearchIndexRotationPeriod"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Amazon ES retry options. RetryOptions *ElasticsearchRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string `min:"1" type:"string"` // The Amazon S3 backup mode. S3BackupMode *string `type:"string" enum:"ElasticsearchS3BackupMode"` // The Amazon S3 destination. S3DestinationDescription *S3DestinationDescription `type:"structure"` // The Elasticsearch type name. This applies to Elasticsearch 6.x and lower // versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value // for TypeName. TypeName *string `type:"string"` // The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch // Serverless destination. VpcConfigurationDescription *VpcConfigurationDescription `type:"structure"` // contains filtered or unexported fields }
The destination description in Amazon ES.
func (s ElasticsearchDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchDestinationDescription) SetBufferingHints(v *ElasticsearchBufferingHints) *ElasticsearchDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *ElasticsearchDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ElasticsearchDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ElasticsearchDestinationDescription) SetClusterEndpoint(v string) *ElasticsearchDestinationDescription
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *ElasticsearchDestinationDescription) SetDocumentIdOptions(v *DocumentIdOptions) *ElasticsearchDestinationDescription
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *ElasticsearchDestinationDescription) SetDomainARN(v string) *ElasticsearchDestinationDescription
SetDomainARN sets the DomainARN field's value.
func (s *ElasticsearchDestinationDescription) SetIndexName(v string) *ElasticsearchDestinationDescription
SetIndexName sets the IndexName field's value.
func (s *ElasticsearchDestinationDescription) SetIndexRotationPeriod(v string) *ElasticsearchDestinationDescription
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *ElasticsearchDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *ElasticsearchDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ElasticsearchDestinationDescription) SetRetryOptions(v *ElasticsearchRetryOptions) *ElasticsearchDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *ElasticsearchDestinationDescription) SetRoleARN(v string) *ElasticsearchDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *ElasticsearchDestinationDescription) SetS3BackupMode(v string) *ElasticsearchDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *ElasticsearchDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *ElasticsearchDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *ElasticsearchDestinationDescription) SetTypeName(v string) *ElasticsearchDestinationDescription
SetTypeName sets the TypeName field's value.
func (s *ElasticsearchDestinationDescription) SetVpcConfigurationDescription(v *VpcConfigurationDescription) *ElasticsearchDestinationDescription
SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.
func (s ElasticsearchDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ElasticsearchDestinationUpdate struct { // The buffering options. If no value is specified, ElasticsearchBufferingHints // object default values are used. BufferingHints *ElasticsearchBufferingHints `type:"structure"` // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The endpoint to use when communicating with the cluster. Specify either this // ClusterEndpoint or the DomainARN field. ClusterEndpoint *string `min:"1" type:"string"` // Indicates the method for setting up document ID. The supported methods are // Firehose generated document ID and OpenSearch Service generated document // ID. DocumentIdOptions *DocumentIdOptions `type:"structure"` // The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, // DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified // in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon // Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // Specify either ClusterEndpoint or DomainARN. DomainARN *string `min:"1" type:"string"` // The Elasticsearch index name. IndexName *string `min:"1" type:"string"` // The Elasticsearch index rotation period. Index rotation appends a timestamp // to IndexName to facilitate the expiration of old data. For more information, // see Index Rotation for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). // Default value is OneDay. IndexRotationPeriod *string `type:"string" enum:"ElasticsearchIndexRotationPeriod"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // ES. The default value is 300 (5 minutes). RetryOptions *ElasticsearchRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose // for calling the Amazon ES Configuration API and for indexing documents. For // more information, see Grant Firehose Access to an Amazon S3 Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string `min:"1" type:"string"` // The Amazon S3 destination. S3Update *S3DestinationUpdate `type:"structure"` // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one // type per index. If you try to specify a new type for an existing index that // already has another type, Firehose returns an error during runtime. // // If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery // stream, Firehose still delivers data to Elasticsearch with the old index // name and type name. If you want to update your delivery stream with a new // index name, provide an empty string for TypeName. TypeName *string `type:"string"` // contains filtered or unexported fields }
Describes an update for a destination in Amazon ES.
func (s ElasticsearchDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchDestinationUpdate) SetBufferingHints(v *ElasticsearchBufferingHints) *ElasticsearchDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *ElasticsearchDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ElasticsearchDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ElasticsearchDestinationUpdate) SetClusterEndpoint(v string) *ElasticsearchDestinationUpdate
SetClusterEndpoint sets the ClusterEndpoint field's value.
func (s *ElasticsearchDestinationUpdate) SetDocumentIdOptions(v *DocumentIdOptions) *ElasticsearchDestinationUpdate
SetDocumentIdOptions sets the DocumentIdOptions field's value.
func (s *ElasticsearchDestinationUpdate) SetDomainARN(v string) *ElasticsearchDestinationUpdate
SetDomainARN sets the DomainARN field's value.
func (s *ElasticsearchDestinationUpdate) SetIndexName(v string) *ElasticsearchDestinationUpdate
SetIndexName sets the IndexName field's value.
func (s *ElasticsearchDestinationUpdate) SetIndexRotationPeriod(v string) *ElasticsearchDestinationUpdate
SetIndexRotationPeriod sets the IndexRotationPeriod field's value.
func (s *ElasticsearchDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *ElasticsearchDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ElasticsearchDestinationUpdate) SetRetryOptions(v *ElasticsearchRetryOptions) *ElasticsearchDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *ElasticsearchDestinationUpdate) SetRoleARN(v string) *ElasticsearchDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *ElasticsearchDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *ElasticsearchDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *ElasticsearchDestinationUpdate) SetTypeName(v string) *ElasticsearchDestinationUpdate
SetTypeName sets the TypeName field's value.
func (s ElasticsearchDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ElasticsearchRetryOptions struct { // After an initial failure to deliver to Amazon ES, the total amount of time // during which Firehose retries delivery (including the first attempt). After // this time has elapsed, the failed documents are written to Amazon S3. Default // value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Configures retry behavior in case Firehose is unable to deliver documents to Amazon ES.
func (s ElasticsearchRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ElasticsearchRetryOptions) SetDurationInSeconds(v int64) *ElasticsearchRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s ElasticsearchRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EncryptionConfiguration struct { // The encryption key. KMSEncryptionConfig *KMSEncryptionConfig `type:"structure"` // Specifically override existing encryption information to ensure that no encryption // is used. NoEncryptionConfig *string `type:"string" enum:"NoEncryptionConfig"` // contains filtered or unexported fields }
Describes the encryption for a destination in Amazon S3.
func (s EncryptionConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EncryptionConfiguration) SetKMSEncryptionConfig(v *KMSEncryptionConfig) *EncryptionConfiguration
SetKMSEncryptionConfig sets the KMSEncryptionConfig field's value.
func (s *EncryptionConfiguration) SetNoEncryptionConfig(v string) *EncryptionConfiguration
SetNoEncryptionConfig sets the NoEncryptionConfig field's value.
func (s EncryptionConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExtendedS3DestinationConfiguration struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // The buffering option. BufferingHints *BufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The compression format. If no value is specified, the default is UNCOMPRESSED. CompressionFormat *string `type:"string" enum:"CompressionFormat"` // The time zone you prefer. UTC is the default. CustomTimeZone *string `type:"string"` // The serializer, deserializer, and schema for converting data from the JSON // format to the Parquet or ORC format before writing it to Amazon S3. DataFormatConversionConfiguration *DataFormatConversionConfiguration `type:"structure"` // The configuration of the dynamic partitioning mechanism that creates smaller // data sets from the streaming data by partitioning it based on partition keys. // Currently, dynamic partitioning is only supported for Amazon S3 destinations. DynamicPartitioningConfiguration *DynamicPartitioningConfiguration `type:"structure"` // The encryption configuration. If no value is specified, the default is no // encryption. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // Specify a file extension. It will override the default file extension FileExtension *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The configuration for backup in Amazon S3. S3BackupConfiguration *S3DestinationConfiguration `type:"structure"` // The Amazon S3 backup mode. After you create a delivery stream, you can update // it to enable Amazon S3 backup if it is disabled. If backup is enabled, you // can't update the delivery stream to disable it. S3BackupMode *string `type:"string" enum:"S3BackupMode"` // contains filtered or unexported fields }
Describes the configuration of a destination in Amazon S3.
func (s ExtendedS3DestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExtendedS3DestinationConfiguration) SetBucketARN(v string) *ExtendedS3DestinationConfiguration
SetBucketARN sets the BucketARN field's value.
func (s *ExtendedS3DestinationConfiguration) SetBufferingHints(v *BufferingHints) *ExtendedS3DestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *ExtendedS3DestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ExtendedS3DestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ExtendedS3DestinationConfiguration) SetCompressionFormat(v string) *ExtendedS3DestinationConfiguration
SetCompressionFormat sets the CompressionFormat field's value.
func (s *ExtendedS3DestinationConfiguration) SetCustomTimeZone(v string) *ExtendedS3DestinationConfiguration
SetCustomTimeZone sets the CustomTimeZone field's value.
func (s *ExtendedS3DestinationConfiguration) SetDataFormatConversionConfiguration(v *DataFormatConversionConfiguration) *ExtendedS3DestinationConfiguration
SetDataFormatConversionConfiguration sets the DataFormatConversionConfiguration field's value.
func (s *ExtendedS3DestinationConfiguration) SetDynamicPartitioningConfiguration(v *DynamicPartitioningConfiguration) *ExtendedS3DestinationConfiguration
SetDynamicPartitioningConfiguration sets the DynamicPartitioningConfiguration field's value.
func (s *ExtendedS3DestinationConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *ExtendedS3DestinationConfiguration
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *ExtendedS3DestinationConfiguration) SetErrorOutputPrefix(v string) *ExtendedS3DestinationConfiguration
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *ExtendedS3DestinationConfiguration) SetFileExtension(v string) *ExtendedS3DestinationConfiguration
SetFileExtension sets the FileExtension field's value.
func (s *ExtendedS3DestinationConfiguration) SetPrefix(v string) *ExtendedS3DestinationConfiguration
SetPrefix sets the Prefix field's value.
func (s *ExtendedS3DestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *ExtendedS3DestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ExtendedS3DestinationConfiguration) SetRoleARN(v string) *ExtendedS3DestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *ExtendedS3DestinationConfiguration) SetS3BackupConfiguration(v *S3DestinationConfiguration) *ExtendedS3DestinationConfiguration
SetS3BackupConfiguration sets the S3BackupConfiguration field's value.
func (s *ExtendedS3DestinationConfiguration) SetS3BackupMode(v string) *ExtendedS3DestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s ExtendedS3DestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExtendedS3DestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExtendedS3DestinationDescription struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // The buffering option. // // BufferingHints is a required field BufferingHints *BufferingHints `type:"structure" required:"true"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The compression format. If no value is specified, the default is UNCOMPRESSED. // // CompressionFormat is a required field CompressionFormat *string `type:"string" required:"true" enum:"CompressionFormat"` // The time zone you prefer. UTC is the default. CustomTimeZone *string `type:"string"` // The serializer, deserializer, and schema for converting data from the JSON // format to the Parquet or ORC format before writing it to Amazon S3. DataFormatConversionConfiguration *DataFormatConversionConfiguration `type:"structure"` // The configuration of the dynamic partitioning mechanism that creates smaller // data sets from the streaming data by partitioning it based on partition keys. // Currently, dynamic partitioning is only supported for Amazon S3 destinations. DynamicPartitioningConfiguration *DynamicPartitioningConfiguration `type:"structure"` // The encryption configuration. If no value is specified, the default is no // encryption. // // EncryptionConfiguration is a required field EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // Specify a file extension. It will override the default file extension FileExtension *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The configuration for backup in Amazon S3. S3BackupDescription *S3DestinationDescription `type:"structure"` // The Amazon S3 backup mode. S3BackupMode *string `type:"string" enum:"S3BackupMode"` // contains filtered or unexported fields }
Describes a destination in Amazon S3.
func (s ExtendedS3DestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExtendedS3DestinationDescription) SetBucketARN(v string) *ExtendedS3DestinationDescription
SetBucketARN sets the BucketARN field's value.
func (s *ExtendedS3DestinationDescription) SetBufferingHints(v *BufferingHints) *ExtendedS3DestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *ExtendedS3DestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ExtendedS3DestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ExtendedS3DestinationDescription) SetCompressionFormat(v string) *ExtendedS3DestinationDescription
SetCompressionFormat sets the CompressionFormat field's value.
func (s *ExtendedS3DestinationDescription) SetCustomTimeZone(v string) *ExtendedS3DestinationDescription
SetCustomTimeZone sets the CustomTimeZone field's value.
func (s *ExtendedS3DestinationDescription) SetDataFormatConversionConfiguration(v *DataFormatConversionConfiguration) *ExtendedS3DestinationDescription
SetDataFormatConversionConfiguration sets the DataFormatConversionConfiguration field's value.
func (s *ExtendedS3DestinationDescription) SetDynamicPartitioningConfiguration(v *DynamicPartitioningConfiguration) *ExtendedS3DestinationDescription
SetDynamicPartitioningConfiguration sets the DynamicPartitioningConfiguration field's value.
func (s *ExtendedS3DestinationDescription) SetEncryptionConfiguration(v *EncryptionConfiguration) *ExtendedS3DestinationDescription
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *ExtendedS3DestinationDescription) SetErrorOutputPrefix(v string) *ExtendedS3DestinationDescription
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *ExtendedS3DestinationDescription) SetFileExtension(v string) *ExtendedS3DestinationDescription
SetFileExtension sets the FileExtension field's value.
func (s *ExtendedS3DestinationDescription) SetPrefix(v string) *ExtendedS3DestinationDescription
SetPrefix sets the Prefix field's value.
func (s *ExtendedS3DestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *ExtendedS3DestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ExtendedS3DestinationDescription) SetRoleARN(v string) *ExtendedS3DestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *ExtendedS3DestinationDescription) SetS3BackupDescription(v *S3DestinationDescription) *ExtendedS3DestinationDescription
SetS3BackupDescription sets the S3BackupDescription field's value.
func (s *ExtendedS3DestinationDescription) SetS3BackupMode(v string) *ExtendedS3DestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s ExtendedS3DestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ExtendedS3DestinationUpdate struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). BucketARN *string `min:"1" type:"string"` // The buffering option. BufferingHints *BufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The compression format. If no value is specified, the default is UNCOMPRESSED. CompressionFormat *string `type:"string" enum:"CompressionFormat"` // The time zone you prefer. UTC is the default. CustomTimeZone *string `type:"string"` // The serializer, deserializer, and schema for converting data from the JSON // format to the Parquet or ORC format before writing it to Amazon S3. DataFormatConversionConfiguration *DataFormatConversionConfiguration `type:"structure"` // The configuration of the dynamic partitioning mechanism that creates smaller // data sets from the streaming data by partitioning it based on partition keys. // Currently, dynamic partitioning is only supported for Amazon S3 destinations. DynamicPartitioningConfiguration *DynamicPartitioningConfiguration `type:"structure"` // The encryption configuration. If no value is specified, the default is no // encryption. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // Specify a file extension. It will override the default file extension FileExtension *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string `min:"1" type:"string"` // You can update a delivery stream to enable Amazon S3 backup if it is disabled. // If backup is enabled, you can't update the delivery stream to disable it. S3BackupMode *string `type:"string" enum:"S3BackupMode"` // The Amazon S3 destination for backup. S3BackupUpdate *S3DestinationUpdate `type:"structure"` // contains filtered or unexported fields }
Describes an update for a destination in Amazon S3.
func (s ExtendedS3DestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExtendedS3DestinationUpdate) SetBucketARN(v string) *ExtendedS3DestinationUpdate
SetBucketARN sets the BucketARN field's value.
func (s *ExtendedS3DestinationUpdate) SetBufferingHints(v *BufferingHints) *ExtendedS3DestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *ExtendedS3DestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ExtendedS3DestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *ExtendedS3DestinationUpdate) SetCompressionFormat(v string) *ExtendedS3DestinationUpdate
SetCompressionFormat sets the CompressionFormat field's value.
func (s *ExtendedS3DestinationUpdate) SetCustomTimeZone(v string) *ExtendedS3DestinationUpdate
SetCustomTimeZone sets the CustomTimeZone field's value.
func (s *ExtendedS3DestinationUpdate) SetDataFormatConversionConfiguration(v *DataFormatConversionConfiguration) *ExtendedS3DestinationUpdate
SetDataFormatConversionConfiguration sets the DataFormatConversionConfiguration field's value.
func (s *ExtendedS3DestinationUpdate) SetDynamicPartitioningConfiguration(v *DynamicPartitioningConfiguration) *ExtendedS3DestinationUpdate
SetDynamicPartitioningConfiguration sets the DynamicPartitioningConfiguration field's value.
func (s *ExtendedS3DestinationUpdate) SetEncryptionConfiguration(v *EncryptionConfiguration) *ExtendedS3DestinationUpdate
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *ExtendedS3DestinationUpdate) SetErrorOutputPrefix(v string) *ExtendedS3DestinationUpdate
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *ExtendedS3DestinationUpdate) SetFileExtension(v string) *ExtendedS3DestinationUpdate
SetFileExtension sets the FileExtension field's value.
func (s *ExtendedS3DestinationUpdate) SetPrefix(v string) *ExtendedS3DestinationUpdate
SetPrefix sets the Prefix field's value.
func (s *ExtendedS3DestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *ExtendedS3DestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *ExtendedS3DestinationUpdate) SetRoleARN(v string) *ExtendedS3DestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *ExtendedS3DestinationUpdate) SetS3BackupMode(v string) *ExtendedS3DestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *ExtendedS3DestinationUpdate) SetS3BackupUpdate(v *S3DestinationUpdate) *ExtendedS3DestinationUpdate
SetS3BackupUpdate sets the S3BackupUpdate field's value.
func (s ExtendedS3DestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExtendedS3DestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FailureDescription struct { // A message providing details about the error that caused the failure. // // Details is a required field Details *string `min:"1" type:"string" required:"true"` // The type of error that caused the failure. // // Type is a required field Type *string `type:"string" required:"true" enum:"DeliveryStreamFailureType"` // contains filtered or unexported fields }
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
func (s FailureDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *FailureDescription) SetDetails(v string) *FailureDescription
SetDetails sets the Details field's value.
func (s *FailureDescription) SetType(v string) *FailureDescription
SetType sets the Type field's value.
func (s FailureDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Firehose struct { *client.Client }
Firehose provides the API operation methods for making requests to Amazon Kinesis Firehose. See this package's package overview docs for details on the service.
Firehose methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Firehose
New creates a new instance of the Firehose client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Firehose client from just a session. svc := firehose.New(mySession) // Create a Firehose client with additional configuration svc := firehose.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Firehose) CreateDeliveryStream(input *CreateDeliveryStreamInput) (*CreateDeliveryStreamOutput, error)
CreateDeliveryStream API operation for Amazon Kinesis Firehose.
Creates a Firehose delivery stream.
By default, you can create up to 50 delivery streams per Amazon Web Services Region.
This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.
If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
A Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled.
A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) in the Amazon Firehose Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation CreateDeliveryStream for usage and error information.
Returned Error Types:
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
ResourceInUseException The resource is already in use and not available for this operation.
InvalidKMSResourceException Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
func (c *Firehose) CreateDeliveryStreamRequest(input *CreateDeliveryStreamInput) (req *request.Request, output *CreateDeliveryStreamOutput)
CreateDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the CreateDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDeliveryStream for more information on using the CreateDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateDeliveryStreamRequest method. req, resp := client.CreateDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) CreateDeliveryStreamWithContext(ctx aws.Context, input *CreateDeliveryStreamInput, opts ...request.Option) (*CreateDeliveryStreamOutput, error)
CreateDeliveryStreamWithContext is the same as CreateDeliveryStream with the addition of the ability to pass a context and additional request options.
See CreateDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) DeleteDeliveryStream(input *DeleteDeliveryStreamInput) (*DeleteDeliveryStreamOutput, error)
DeleteDeliveryStream API operation for Amazon Kinesis Firehose.
Deletes a delivery stream and its data.
You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. To check the state of a delivery stream, use DescribeDeliveryStream.
DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and it goes into the DELETING state.While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream.
Removal of a delivery stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation DeleteDeliveryStream for usage and error information.
Returned Error Types:
ResourceInUseException The resource is already in use and not available for this operation.
ResourceNotFoundException The specified resource could not be found.
func (c *Firehose) DeleteDeliveryStreamRequest(input *DeleteDeliveryStreamInput) (req *request.Request, output *DeleteDeliveryStreamOutput)
DeleteDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDeliveryStream for more information on using the DeleteDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteDeliveryStreamRequest method. req, resp := client.DeleteDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) DeleteDeliveryStreamWithContext(ctx aws.Context, input *DeleteDeliveryStreamInput, opts ...request.Option) (*DeleteDeliveryStreamOutput, error)
DeleteDeliveryStreamWithContext is the same as DeleteDeliveryStream with the addition of the ability to pass a context and additional request options.
See DeleteDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) DescribeDeliveryStream(input *DescribeDeliveryStreamInput) (*DescribeDeliveryStreamOutput, error)
DescribeDeliveryStream API operation for Amazon Kinesis Firehose.
Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.
If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation DescribeDeliveryStream for usage and error information.
Returned Error Types:
func (c *Firehose) DescribeDeliveryStreamRequest(input *DescribeDeliveryStreamInput) (req *request.Request, output *DescribeDeliveryStreamOutput)
DescribeDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDeliveryStream for more information on using the DescribeDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDeliveryStreamRequest method. req, resp := client.DescribeDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) DescribeDeliveryStreamWithContext(ctx aws.Context, input *DescribeDeliveryStreamInput, opts ...request.Option) (*DescribeDeliveryStreamOutput, error)
DescribeDeliveryStreamWithContext is the same as DescribeDeliveryStream with the addition of the ability to pass a context and additional request options.
See DescribeDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) ListDeliveryStreams(input *ListDeliveryStreamsInput) (*ListDeliveryStreamsOutput, error)
ListDeliveryStreams API operation for Amazon Kinesis Firehose.
Lists your delivery streams in alphabetical order of their names.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation ListDeliveryStreams for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ListDeliveryStreams
func (c *Firehose) ListDeliveryStreamsRequest(input *ListDeliveryStreamsInput) (req *request.Request, output *ListDeliveryStreamsOutput)
ListDeliveryStreamsRequest generates a "aws/request.Request" representing the client's request for the ListDeliveryStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDeliveryStreams for more information on using the ListDeliveryStreams API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDeliveryStreamsRequest method. req, resp := client.ListDeliveryStreamsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ListDeliveryStreams
func (c *Firehose) ListDeliveryStreamsWithContext(ctx aws.Context, input *ListDeliveryStreamsInput, opts ...request.Option) (*ListDeliveryStreamsOutput, error)
ListDeliveryStreamsWithContext is the same as ListDeliveryStreams with the addition of the ability to pass a context and additional request options.
See ListDeliveryStreams for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) ListTagsForDeliveryStream(input *ListTagsForDeliveryStreamInput) (*ListTagsForDeliveryStreamOutput, error)
ListTagsForDeliveryStream API operation for Amazon Kinesis Firehose.
Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation ListTagsForDeliveryStream for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
func (c *Firehose) ListTagsForDeliveryStreamRequest(input *ListTagsForDeliveryStreamInput) (req *request.Request, output *ListTagsForDeliveryStreamOutput)
ListTagsForDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the ListTagsForDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForDeliveryStream for more information on using the ListTagsForDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForDeliveryStreamRequest method. req, resp := client.ListTagsForDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) ListTagsForDeliveryStreamWithContext(ctx aws.Context, input *ListTagsForDeliveryStreamInput, opts ...request.Option) (*ListTagsForDeliveryStreamOutput, error)
ListTagsForDeliveryStreamWithContext is the same as ListTagsForDeliveryStream with the addition of the ability to pass a context and additional request options.
See ListTagsForDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) PutRecord(input *PutRecordInput) (*PutRecordOutput, error)
PutRecord API operation for Amazon Kinesis Firehose.
Writes a single data record into an Amazon Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.
By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html).
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.
If the PutRecord operation throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation PutRecord for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
InvalidArgumentException The specified input parameter has a value that is not valid.
InvalidKMSResourceException Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
InvalidSourceException Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
ServiceUnavailableException The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html).
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/PutRecord
func (c *Firehose) PutRecordBatch(input *PutRecordBatchInput) (*PutRecordBatchOutput, error)
PutRecordBatch API operation for Amazon Kinesis Firehose.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
For information about service quota, see Amazon Firehose Quota (https://docs.aws.amazon.com/firehose/latest/dev/limits.html).
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation PutRecordBatch for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
InvalidArgumentException The specified input parameter has a value that is not valid.
InvalidKMSResourceException Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
InvalidSourceException Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
ServiceUnavailableException The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html).
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/PutRecordBatch
func (c *Firehose) PutRecordBatchRequest(input *PutRecordBatchInput) (req *request.Request, output *PutRecordBatchOutput)
PutRecordBatchRequest generates a "aws/request.Request" representing the client's request for the PutRecordBatch operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutRecordBatch for more information on using the PutRecordBatch API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutRecordBatchRequest method. req, resp := client.PutRecordBatchRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/PutRecordBatch
func (c *Firehose) PutRecordBatchWithContext(ctx aws.Context, input *PutRecordBatchInput, opts ...request.Option) (*PutRecordBatchOutput, error)
PutRecordBatchWithContext is the same as PutRecordBatch with the addition of the ability to pass a context and additional request options.
See PutRecordBatch for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) PutRecordRequest(input *PutRecordInput) (req *request.Request, output *PutRecordOutput)
PutRecordRequest generates a "aws/request.Request" representing the client's request for the PutRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutRecord for more information on using the PutRecord API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutRecordRequest method. req, resp := client.PutRecordRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/PutRecord
func (c *Firehose) PutRecordWithContext(ctx aws.Context, input *PutRecordInput, opts ...request.Option) (*PutRecordOutput, error)
PutRecordWithContext is the same as PutRecord with the addition of the ability to pass a context and additional request options.
See PutRecord for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) StartDeliveryStreamEncryption(input *StartDeliveryStreamEncryptionInput) (*StartDeliveryStreamEncryptionOutput, error)
StartDeliveryStreamEncryption API operation for Amazon Kinesis Firehose.
Enables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.
For the KMS grant creation to be successful, the Firehose API operations StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.
If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation StartDeliveryStreamEncryption for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
ResourceInUseException The resource is already in use and not available for this operation.
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
InvalidKMSResourceException Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
func (c *Firehose) StartDeliveryStreamEncryptionRequest(input *StartDeliveryStreamEncryptionInput) (req *request.Request, output *StartDeliveryStreamEncryptionOutput)
StartDeliveryStreamEncryptionRequest generates a "aws/request.Request" representing the client's request for the StartDeliveryStreamEncryption operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartDeliveryStreamEncryption for more information on using the StartDeliveryStreamEncryption API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartDeliveryStreamEncryptionRequest method. req, resp := client.StartDeliveryStreamEncryptionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) StartDeliveryStreamEncryptionWithContext(ctx aws.Context, input *StartDeliveryStreamEncryptionInput, opts ...request.Option) (*StartDeliveryStreamEncryptionOutput, error)
StartDeliveryStreamEncryptionWithContext is the same as StartDeliveryStreamEncryption with the addition of the ability to pass a context and additional request options.
See StartDeliveryStreamEncryption for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) StopDeliveryStreamEncryption(input *StopDeliveryStreamEncryptionInput) (*StopDeliveryStreamEncryptionOutput, error)
StopDeliveryStreamEncryption API operation for Amazon Kinesis Firehose.
Disables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation StopDeliveryStreamEncryption for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
ResourceInUseException The resource is already in use and not available for this operation.
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
func (c *Firehose) StopDeliveryStreamEncryptionRequest(input *StopDeliveryStreamEncryptionInput) (req *request.Request, output *StopDeliveryStreamEncryptionOutput)
StopDeliveryStreamEncryptionRequest generates a "aws/request.Request" representing the client's request for the StopDeliveryStreamEncryption operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopDeliveryStreamEncryption for more information on using the StopDeliveryStreamEncryption API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopDeliveryStreamEncryptionRequest method. req, resp := client.StopDeliveryStreamEncryptionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Firehose) StopDeliveryStreamEncryptionWithContext(ctx aws.Context, input *StopDeliveryStreamEncryptionInput, opts ...request.Option) (*StopDeliveryStreamEncryptionOutput, error)
StopDeliveryStreamEncryptionWithContext is the same as StopDeliveryStreamEncryption with the addition of the ability to pass a context and additional request options.
See StopDeliveryStreamEncryption for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) TagDeliveryStream(input *TagDeliveryStreamInput) (*TagDeliveryStreamOutput, error)
TagDeliveryStream API operation for Amazon Kinesis Firehose.
Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the Amazon Web Services Billing and Cost Management User Guide.
Each delivery stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation TagDeliveryStream for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
ResourceInUseException The resource is already in use and not available for this operation.
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagDeliveryStream
func (c *Firehose) TagDeliveryStreamRequest(input *TagDeliveryStreamInput) (req *request.Request, output *TagDeliveryStreamOutput)
TagDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the TagDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagDeliveryStream for more information on using the TagDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagDeliveryStreamRequest method. req, resp := client.TagDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagDeliveryStream
func (c *Firehose) TagDeliveryStreamWithContext(ctx aws.Context, input *TagDeliveryStreamInput, opts ...request.Option) (*TagDeliveryStreamOutput, error)
TagDeliveryStreamWithContext is the same as TagDeliveryStream with the addition of the ability to pass a context and additional request options.
See TagDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) UntagDeliveryStream(input *UntagDeliveryStreamInput) (*UntagDeliveryStreamOutput, error)
UntagDeliveryStream API operation for Amazon Kinesis Firehose.
Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.
If you specify a tag that doesn't exist, the operation ignores it.
This operation has a limit of five transactions per second per account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation UntagDeliveryStream for usage and error information.
Returned Error Types:
ResourceNotFoundException The specified resource could not be found.
ResourceInUseException The resource is already in use and not available for this operation.
InvalidArgumentException The specified input parameter has a value that is not valid.
LimitExceededException You have already reached the limit for a requested resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UntagDeliveryStream
func (c *Firehose) UntagDeliveryStreamRequest(input *UntagDeliveryStreamInput) (req *request.Request, output *UntagDeliveryStreamOutput)
UntagDeliveryStreamRequest generates a "aws/request.Request" representing the client's request for the UntagDeliveryStream operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagDeliveryStream for more information on using the UntagDeliveryStream API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagDeliveryStreamRequest method. req, resp := client.UntagDeliveryStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UntagDeliveryStream
func (c *Firehose) UntagDeliveryStreamWithContext(ctx aws.Context, input *UntagDeliveryStreamInput, opts ...request.Option) (*UntagDeliveryStreamOutput, error)
UntagDeliveryStreamWithContext is the same as UntagDeliveryStream with the addition of the ability to pass a context and additional request options.
See UntagDeliveryStream for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Firehose) UpdateDestination(input *UpdateDestinationInput) (*UpdateDestinationOutput, error)
UpdateDestination API operation for Amazon Kinesis Firehose.
Updates the specified destination of the specified delivery stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination.
If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.
Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Kinesis Firehose's API operation UpdateDestination for usage and error information.
Returned Error Types:
InvalidArgumentException The specified input parameter has a value that is not valid.
ResourceInUseException The resource is already in use and not available for this operation.
ResourceNotFoundException The specified resource could not be found.
ConcurrentModificationException Another modification has already happened. Fetch VersionId again and use it to update the destination.
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UpdateDestination
func (c *Firehose) UpdateDestinationRequest(input *UpdateDestinationInput) (req *request.Request, output *UpdateDestinationOutput)
UpdateDestinationRequest generates a "aws/request.Request" representing the client's request for the UpdateDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDestination for more information on using the UpdateDestination API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateDestinationRequest method. req, resp := client.UpdateDestinationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UpdateDestination
func (c *Firehose) UpdateDestinationWithContext(ctx aws.Context, input *UpdateDestinationInput, opts ...request.Option) (*UpdateDestinationOutput, error)
UpdateDestinationWithContext is the same as UpdateDestination with the addition of the ability to pass a context and additional request options.
See UpdateDestination for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type HiveJsonSerDe struct { // Indicates how you want Firehose to parse the date and timestamps that may // be present in your input data JSON. To specify these format strings, follow // the pattern syntax of JodaTime's DateTimeFormat format strings. For more // information, see Class DateTimeFormat (https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html). // You can also use the special value millis to parse timestamps in epoch milliseconds. // If you don't specify a format, Firehose uses java.sql.Timestamp::valueOf // by default. TimestampFormats []*string `type:"list"` // contains filtered or unexported fields }
The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
func (s HiveJsonSerDe) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HiveJsonSerDe) SetTimestampFormats(v []*string) *HiveJsonSerDe
SetTimestampFormats sets the TimestampFormats field's value.
func (s HiveJsonSerDe) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type HttpEndpointBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300 (5 minutes). IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 5. // // We recommend setting this parameter to a value greater than the amount of // data you typically ingest into the delivery stream in 10 seconds. For example, // if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
func (s HttpEndpointBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointBufferingHints) SetIntervalInSeconds(v int64) *HttpEndpointBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *HttpEndpointBufferingHints) SetSizeInMBs(v int64) *HttpEndpointBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s HttpEndpointBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointCommonAttribute struct { // The name of the HTTP endpoint common attribute. // // AttributeName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HttpEndpointCommonAttribute's // String and GoString methods. // // AttributeName is a required field AttributeName *string `min:"1" type:"string" required:"true" sensitive:"true"` // The value of the HTTP endpoint common attribute. // // AttributeValue is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HttpEndpointCommonAttribute's // String and GoString methods. // // AttributeValue is a required field AttributeValue *string `type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
Describes the metadata that's delivered to the specified HTTP endpoint destination.
func (s HttpEndpointCommonAttribute) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointCommonAttribute) SetAttributeName(v string) *HttpEndpointCommonAttribute
SetAttributeName sets the AttributeName field's value.
func (s *HttpEndpointCommonAttribute) SetAttributeValue(v string) *HttpEndpointCommonAttribute
SetAttributeValue sets the AttributeValue field's value.
func (s HttpEndpointCommonAttribute) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointCommonAttribute) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointConfiguration struct { // The access key required for Kinesis Firehose to authenticate with the HTTP // endpoint selected as the destination. // // AccessKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HttpEndpointConfiguration's // String and GoString methods. AccessKey *string `type:"string" sensitive:"true"` // The name of the HTTP endpoint selected as the destination. Name *string `min:"1" type:"string"` // The URL of the HTTP endpoint selected as the destination. // // If you choose an HTTP endpoint as your destination, review and follow the // instructions in the Appendix - HTTP Endpoint Delivery Request and Response // Specifications (https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html). // // Url is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HttpEndpointConfiguration's // String and GoString methods. // // Url is a required field Url *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
func (s HttpEndpointConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointConfiguration) SetAccessKey(v string) *HttpEndpointConfiguration
SetAccessKey sets the AccessKey field's value.
func (s *HttpEndpointConfiguration) SetName(v string) *HttpEndpointConfiguration
SetName sets the Name field's value.
func (s *HttpEndpointConfiguration) SetUrl(v string) *HttpEndpointConfiguration
SetUrl sets the Url field's value.
func (s HttpEndpointConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointDescription struct { // The name of the HTTP endpoint selected as the destination. Name *string `min:"1" type:"string"` // The URL of the HTTP endpoint selected as the destination. // // Url is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by HttpEndpointDescription's // String and GoString methods. Url *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Describes the HTTP endpoint selected as the destination.
func (s HttpEndpointDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDescription) SetName(v string) *HttpEndpointDescription
SetName sets the Name field's value.
func (s *HttpEndpointDescription) SetUrl(v string) *HttpEndpointDescription
SetUrl sets the Url field's value.
func (s HttpEndpointDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type HttpEndpointDestinationConfiguration struct { // The buffering options that can be used before data is delivered to the specified // destination. Firehose treats these options as hints, and it might choose // to use more optimal values. The SizeInMBs and IntervalInSeconds parameters // are optional. However, if you specify a value for one of them, you must also // provide a value for the other. BufferingHints *HttpEndpointBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The configuration of the HTTP endpoint selected as the destination. // // EndpointConfiguration is a required field EndpointConfiguration *HttpEndpointConfiguration `type:"structure" required:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The configuration of the request sent to the HTTP endpoint that is specified // as the destination. RequestConfiguration *HttpEndpointRequestConfiguration `type:"structure"` // Describes the retry behavior in case Firehose is unable to deliver data to // the specified HTTP endpoint destination, or if it doesn't receive a valid // acknowledgment of receipt from the specified HTTP endpoint destination. RetryOptions *HttpEndpointRetryOptions `type:"structure"` // Firehose uses this IAM role for all the permissions that the delivery stream // needs. RoleARN *string `min:"1" type:"string"` // Describes the S3 bucket backup options for the data that Firehose delivers // to the HTTP endpoint destination. You can back up all documents (AllData) // or only the documents that Firehose could not deliver to the specified HTTP // endpoint destination (FailedDataOnly). S3BackupMode *string `type:"string" enum:"HttpEndpointS3BackupMode"` // Describes the configuration of a destination in Amazon S3. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The configuration that defines how you access secrets for HTTP Endpoint destination. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the configuration of the HTTP endpoint destination.
func (s HttpEndpointDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDestinationConfiguration) SetBufferingHints(v *HttpEndpointBufferingHints) *HttpEndpointDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *HttpEndpointDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *HttpEndpointDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *HttpEndpointDestinationConfiguration) SetEndpointConfiguration(v *HttpEndpointConfiguration) *HttpEndpointDestinationConfiguration
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (s *HttpEndpointDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *HttpEndpointDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *HttpEndpointDestinationConfiguration) SetRequestConfiguration(v *HttpEndpointRequestConfiguration) *HttpEndpointDestinationConfiguration
SetRequestConfiguration sets the RequestConfiguration field's value.
func (s *HttpEndpointDestinationConfiguration) SetRetryOptions(v *HttpEndpointRetryOptions) *HttpEndpointDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *HttpEndpointDestinationConfiguration) SetRoleARN(v string) *HttpEndpointDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *HttpEndpointDestinationConfiguration) SetS3BackupMode(v string) *HttpEndpointDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *HttpEndpointDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *HttpEndpointDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *HttpEndpointDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationConfiguration
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s HttpEndpointDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointDestinationDescription struct { // Describes buffering options that can be applied to the data before it is // delivered to the HTTPS endpoint destination. Firehose teats these options // as hints, and it might choose to use more optimal values. The SizeInMBs and // IntervalInSeconds parameters are optional. However, if specify a value for // one of them, you must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The configuration of the specified HTTP endpoint destination. EndpointConfiguration *HttpEndpointDescription `type:"structure"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The configuration of request sent to the HTTP endpoint specified as the destination. RequestConfiguration *HttpEndpointRequestConfiguration `type:"structure"` // Describes the retry behavior in case Firehose is unable to deliver data to // the specified HTTP endpoint destination, or if it doesn't receive a valid // acknowledgment of receipt from the specified HTTP endpoint destination. RetryOptions *HttpEndpointRetryOptions `type:"structure"` // Firehose uses this IAM role for all the permissions that the delivery stream // needs. RoleARN *string `min:"1" type:"string"` // Describes the S3 bucket backup options for the data that Kinesis Firehose // delivers to the HTTP endpoint destination. You can back up all documents // (AllData) or only the documents that Firehose could not deliver to the specified // HTTP endpoint destination (FailedDataOnly). S3BackupMode *string `type:"string" enum:"HttpEndpointS3BackupMode"` // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // The configuration that defines how you access secrets for HTTP Endpoint destination. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the HTTP endpoint destination.
func (s HttpEndpointDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDestinationDescription) SetBufferingHints(v *HttpEndpointBufferingHints) *HttpEndpointDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *HttpEndpointDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *HttpEndpointDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *HttpEndpointDestinationDescription) SetEndpointConfiguration(v *HttpEndpointDescription) *HttpEndpointDestinationDescription
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (s *HttpEndpointDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *HttpEndpointDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *HttpEndpointDestinationDescription) SetRequestConfiguration(v *HttpEndpointRequestConfiguration) *HttpEndpointDestinationDescription
SetRequestConfiguration sets the RequestConfiguration field's value.
func (s *HttpEndpointDestinationDescription) SetRetryOptions(v *HttpEndpointRetryOptions) *HttpEndpointDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *HttpEndpointDestinationDescription) SetRoleARN(v string) *HttpEndpointDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *HttpEndpointDestinationDescription) SetS3BackupMode(v string) *HttpEndpointDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *HttpEndpointDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *HttpEndpointDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *HttpEndpointDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationDescription
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s HttpEndpointDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type HttpEndpointDestinationUpdate struct { // Describes buffering options that can be applied to the data before it is // delivered to the HTTPS endpoint destination. Firehose teats these options // as hints, and it might choose to use more optimal values. The SizeInMBs and // IntervalInSeconds parameters are optional. However, if specify a value for // one of them, you must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // Describes the configuration of the HTTP endpoint destination. EndpointConfiguration *HttpEndpointConfiguration `type:"structure"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The configuration of the request sent to the HTTP endpoint specified as the // destination. RequestConfiguration *HttpEndpointRequestConfiguration `type:"structure"` // Describes the retry behavior in case Firehose is unable to deliver data to // the specified HTTP endpoint destination, or if it doesn't receive a valid // acknowledgment of receipt from the specified HTTP endpoint destination. RetryOptions *HttpEndpointRetryOptions `type:"structure"` // Firehose uses this IAM role for all the permissions that the delivery stream // needs. RoleARN *string `min:"1" type:"string"` // Describes the S3 bucket backup options for the data that Kinesis Firehose // delivers to the HTTP endpoint destination. You can back up all documents // (AllData) or only the documents that Firehose could not deliver to the specified // HTTP endpoint destination (FailedDataOnly). S3BackupMode *string `type:"string" enum:"HttpEndpointS3BackupMode"` // Describes an update for a destination in Amazon S3. S3Update *S3DestinationUpdate `type:"structure"` // The configuration that defines how you access secrets for HTTP Endpoint destination. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Updates the specified HTTP endpoint destination.
func (s HttpEndpointDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDestinationUpdate) SetBufferingHints(v *HttpEndpointBufferingHints) *HttpEndpointDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *HttpEndpointDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *HttpEndpointDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *HttpEndpointDestinationUpdate) SetEndpointConfiguration(v *HttpEndpointConfiguration) *HttpEndpointDestinationUpdate
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (s *HttpEndpointDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *HttpEndpointDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *HttpEndpointDestinationUpdate) SetRequestConfiguration(v *HttpEndpointRequestConfiguration) *HttpEndpointDestinationUpdate
SetRequestConfiguration sets the RequestConfiguration field's value.
func (s *HttpEndpointDestinationUpdate) SetRetryOptions(v *HttpEndpointRetryOptions) *HttpEndpointDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *HttpEndpointDestinationUpdate) SetRoleARN(v string) *HttpEndpointDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *HttpEndpointDestinationUpdate) SetS3BackupMode(v string) *HttpEndpointDestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *HttpEndpointDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *HttpEndpointDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *HttpEndpointDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *HttpEndpointDestinationUpdate
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s HttpEndpointDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointRequestConfiguration struct { // Describes the metadata sent to the HTTP endpoint destination. CommonAttributes []*HttpEndpointCommonAttribute `type:"list"` // Firehose uses the content encoding to compress the body of a request before // sending the request to the destination. For more information, see Content-Encoding // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) // in MDN Web Docs, the official Mozilla documentation. ContentEncoding *string `type:"string" enum:"ContentEncoding"` // contains filtered or unexported fields }
The configuration of the HTTP endpoint request.
func (s HttpEndpointRequestConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointRequestConfiguration) SetCommonAttributes(v []*HttpEndpointCommonAttribute) *HttpEndpointRequestConfiguration
SetCommonAttributes sets the CommonAttributes field's value.
func (s *HttpEndpointRequestConfiguration) SetContentEncoding(v string) *HttpEndpointRequestConfiguration
SetContentEncoding sets the ContentEncoding field's value.
func (s HttpEndpointRequestConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointRequestConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HttpEndpointRetryOptions struct { // The total amount of time that Firehose spends on retries. This duration starts // after the initial attempt to send data to the custom destination via HTTPS // endpoint fails. It doesn't include the periods during which Firehose waits // for acknowledgment from the specified destination after each attempt. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
func (s HttpEndpointRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *HttpEndpointRetryOptions) SetDurationInSeconds(v int64) *HttpEndpointRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s HttpEndpointRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IcebergDestinationConfiguration struct { // Describes hints for the buffering to perform before delivering data to the // destination. These options are treated as hints, and therefore Firehose might // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds // parameters are optional. However, if specify a value for one of them, you // must also provide a value for the other. BufferingHints *BufferingHints `type:"structure"` // Configuration describing where the destination Apache Iceberg Tables are // persisted. // // Amazon Data Firehose is in preview release and is subject to change. // // CatalogConfiguration is a required field CatalogConfiguration *CatalogConfiguration `type:"structure" required:"true"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // Provides a list of DestinationTableConfigurations which Firehose uses to // deliver data to Apache Iceberg tables. // // Amazon Data Firehose is in preview release and is subject to change. DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to an Amazon // S3 prefix. RetryOptions *RetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Apache Iceberg tables role. // // Amazon Data Firehose is in preview release and is subject to change. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // Describes how Firehose will backup records. Currently,Firehose only supports // FailedDataOnly for preview. // // Amazon Data Firehose is in preview release and is subject to change. S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` // Describes the configuration of a destination in Amazon S3. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // contains filtered or unexported fields }
Specifies the destination configure settings for Apache Iceberg Table.
Amazon Data Firehose is in preview release and is subject to change.
func (s IcebergDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcebergDestinationConfiguration) SetBufferingHints(v *BufferingHints) *IcebergDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *IcebergDestinationConfiguration) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationConfiguration
SetCatalogConfiguration sets the CatalogConfiguration field's value.
func (s *IcebergDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *IcebergDestinationConfiguration) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationConfiguration
SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value.
func (s *IcebergDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *IcebergDestinationConfiguration) SetRetryOptions(v *RetryOptions) *IcebergDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *IcebergDestinationConfiguration) SetRoleARN(v string) *IcebergDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *IcebergDestinationConfiguration) SetS3BackupMode(v string) *IcebergDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *IcebergDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *IcebergDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s IcebergDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcebergDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IcebergDestinationDescription struct { // Describes hints for the buffering to perform before delivering data to the // destination. These options are treated as hints, and therefore Firehose might // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds // parameters are optional. However, if specify a value for one of them, you // must also provide a value for the other. BufferingHints *BufferingHints `type:"structure"` // Configuration describing where the destination Iceberg tables are persisted. // // Amazon Data Firehose is in preview release and is subject to change. CatalogConfiguration *CatalogConfiguration `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // Provides a list of DestinationTableConfigurations which Firehose uses to // deliver data to Apache Iceberg tables. // // Amazon Data Firehose is in preview release and is subject to change. DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to an Amazon // S3 prefix. RetryOptions *RetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Apache Iceberg Tables role. // // Amazon Data Firehose is in preview release and is subject to change. RoleARN *string `min:"1" type:"string"` // Describes how Firehose will backup records. Currently,Firehose only supports // FailedDataOnly for preview. // // Amazon Data Firehose is in preview release and is subject to change. S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // contains filtered or unexported fields }
Describes a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
func (s IcebergDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcebergDestinationDescription) SetBufferingHints(v *BufferingHints) *IcebergDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *IcebergDestinationDescription) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationDescription
SetCatalogConfiguration sets the CatalogConfiguration field's value.
func (s *IcebergDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *IcebergDestinationDescription) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationDescription
SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value.
func (s *IcebergDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *IcebergDestinationDescription) SetRetryOptions(v *RetryOptions) *IcebergDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *IcebergDestinationDescription) SetRoleARN(v string) *IcebergDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *IcebergDestinationDescription) SetS3BackupMode(v string) *IcebergDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *IcebergDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *IcebergDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s IcebergDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IcebergDestinationUpdate struct { // Describes hints for the buffering to perform before delivering data to the // destination. These options are treated as hints, and therefore Firehose might // choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds // parameters are optional. However, if specify a value for one of them, you // must also provide a value for the other. BufferingHints *BufferingHints `type:"structure"` // Configuration describing where the destination Iceberg tables are persisted. // // Amazon Data Firehose is in preview release and is subject to change. CatalogConfiguration *CatalogConfiguration `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // Provides a list of DestinationTableConfigurations which Firehose uses to // deliver data to Apache Iceberg tables. // // Amazon Data Firehose is in preview release and is subject to change. DestinationTableConfigurationList []*DestinationTableConfiguration `type:"list"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to an Amazon // S3 prefix. RetryOptions *RetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Apache Iceberg Tables role. // // Amazon Data Firehose is in preview release and is subject to change. RoleARN *string `min:"1" type:"string"` // Describes how Firehose will backup records. Currently,Firehose only supports // FailedDataOnly for preview. // // Amazon Data Firehose is in preview release and is subject to change. S3BackupMode *string `type:"string" enum:"IcebergS3BackupMode"` // Describes the configuration of a destination in Amazon S3. S3Configuration *S3DestinationConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes an update for a destination in Apache Iceberg Tables.
Amazon Data Firehose is in preview release and is subject to change.
func (s IcebergDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcebergDestinationUpdate) SetBufferingHints(v *BufferingHints) *IcebergDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *IcebergDestinationUpdate) SetCatalogConfiguration(v *CatalogConfiguration) *IcebergDestinationUpdate
SetCatalogConfiguration sets the CatalogConfiguration field's value.
func (s *IcebergDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *IcebergDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *IcebergDestinationUpdate) SetDestinationTableConfigurationList(v []*DestinationTableConfiguration) *IcebergDestinationUpdate
SetDestinationTableConfigurationList sets the DestinationTableConfigurationList field's value.
func (s *IcebergDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *IcebergDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *IcebergDestinationUpdate) SetRetryOptions(v *RetryOptions) *IcebergDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *IcebergDestinationUpdate) SetRoleARN(v string) *IcebergDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *IcebergDestinationUpdate) SetS3BackupMode(v string) *IcebergDestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *IcebergDestinationUpdate) SetS3Configuration(v *S3DestinationConfiguration) *IcebergDestinationUpdate
SetS3Configuration sets the S3Configuration field's value.
func (s IcebergDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IcebergDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputFormatConfiguration struct { // Specifies which deserializer to use. You can choose either the Apache Hive // JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects // the request. Deserializer *Deserializer `type:"structure"` // contains filtered or unexported fields }
Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.
func (s InputFormatConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InputFormatConfiguration) SetDeserializer(v *Deserializer) *InputFormatConfiguration
SetDeserializer sets the Deserializer field's value.
func (s InputFormatConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidArgumentException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified input parameter has a value that is not valid.
func (s *InvalidArgumentException) Code() string
Code returns the exception type name.
func (s *InvalidArgumentException) Error() string
func (s InvalidArgumentException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidArgumentException) Message() string
Message returns the exception's message.
func (s *InvalidArgumentException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidArgumentException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidArgumentException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidArgumentException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidKMSResourceException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
func (s *InvalidKMSResourceException) Code() string
Code returns the exception type name.
func (s *InvalidKMSResourceException) Error() string
func (s InvalidKMSResourceException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidKMSResourceException) Message() string
Message returns the exception's message.
func (s *InvalidKMSResourceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidKMSResourceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidKMSResourceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidKMSResourceException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidSourceException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
func (s *InvalidSourceException) Code() string
Code returns the exception type name.
func (s *InvalidSourceException) Error() string
func (s InvalidSourceException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidSourceException) Message() string
Message returns the exception's message.
func (s *InvalidSourceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidSourceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidSourceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidSourceException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type KMSEncryptionConfig struct { // The Amazon Resource Name (ARN) of the encryption key. Must belong to the // same Amazon Web Services Region as the destination Amazon S3 bucket. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // AWSKMSKeyARN is a required field AWSKMSKeyARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes an encryption key for a destination in Amazon S3.
func (s KMSEncryptionConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KMSEncryptionConfig) SetAWSKMSKeyARN(v string) *KMSEncryptionConfig
SetAWSKMSKeyARN sets the AWSKMSKeyARN field's value.
func (s KMSEncryptionConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KMSEncryptionConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamSourceConfiguration struct { // The ARN of the source Kinesis data stream. For more information, see Amazon // Kinesis Data Streams ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). // // KinesisStreamARN is a required field KinesisStreamARN *string `min:"1" type:"string" required:"true"` // The ARN of the role that provides access to the source Kinesis data stream. // For more information, see Amazon Web Services Identity and Access Management // (IAM) ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.
func (s KinesisStreamSourceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KinesisStreamSourceConfiguration) SetKinesisStreamARN(v string) *KinesisStreamSourceConfiguration
SetKinesisStreamARN sets the KinesisStreamARN field's value.
func (s *KinesisStreamSourceConfiguration) SetRoleARN(v string) *KinesisStreamSourceConfiguration
SetRoleARN sets the RoleARN field's value.
func (s KinesisStreamSourceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KinesisStreamSourceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamSourceDescription struct { // Firehose starts retrieving records from the Kinesis data stream starting // with this timestamp. DeliveryStartTimestamp *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the source Kinesis data stream. For more // information, see Amazon Kinesis Data Streams ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). KinesisStreamARN *string `min:"1" type:"string"` // The ARN of the role used by the source Kinesis data stream. For more information, // see Amazon Web Services Identity and Access Management (IAM) ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
Details about a Kinesis data stream used as the source for a Firehose delivery stream.
func (s KinesisStreamSourceDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KinesisStreamSourceDescription) SetDeliveryStartTimestamp(v time.Time) *KinesisStreamSourceDescription
SetDeliveryStartTimestamp sets the DeliveryStartTimestamp field's value.
func (s *KinesisStreamSourceDescription) SetKinesisStreamARN(v string) *KinesisStreamSourceDescription
SetKinesisStreamARN sets the KinesisStreamARN field's value.
func (s *KinesisStreamSourceDescription) SetRoleARN(v string) *KinesisStreamSourceDescription
SetRoleARN sets the RoleARN field's value.
func (s KinesisStreamSourceDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You have already reached the limit for a requested resource.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDeliveryStreamsInput struct { // The delivery stream type. This can be one of the following values: // // * DirectPut: Provider applications access the delivery stream directly. // // * KinesisStreamAsSource: The delivery stream uses a Kinesis data stream // as a source. // // This parameter is optional. If this parameter is omitted, delivery streams // of all types are returned. DeliveryStreamType *string `type:"string" enum:"DeliveryStreamType"` // The list of delivery streams returned by this call to ListDeliveryStreams // will start with the delivery stream whose name comes alphabetically immediately // after the name you specify in ExclusiveStartDeliveryStreamName. ExclusiveStartDeliveryStreamName *string `min:"1" type:"string"` // The maximum number of delivery streams to list. The default value is 10. Limit *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
func (s ListDeliveryStreamsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeliveryStreamsInput) SetDeliveryStreamType(v string) *ListDeliveryStreamsInput
SetDeliveryStreamType sets the DeliveryStreamType field's value.
func (s *ListDeliveryStreamsInput) SetExclusiveStartDeliveryStreamName(v string) *ListDeliveryStreamsInput
SetExclusiveStartDeliveryStreamName sets the ExclusiveStartDeliveryStreamName field's value.
func (s *ListDeliveryStreamsInput) SetLimit(v int64) *ListDeliveryStreamsInput
SetLimit sets the Limit field's value.
func (s ListDeliveryStreamsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeliveryStreamsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDeliveryStreamsOutput struct { // The names of the delivery streams. // // DeliveryStreamNames is a required field DeliveryStreamNames []*string `type:"list" required:"true"` // Indicates whether there are more delivery streams available to list. // // HasMoreDeliveryStreams is a required field HasMoreDeliveryStreams *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
func (s ListDeliveryStreamsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeliveryStreamsOutput) SetDeliveryStreamNames(v []*string) *ListDeliveryStreamsOutput
SetDeliveryStreamNames sets the DeliveryStreamNames field's value.
func (s *ListDeliveryStreamsOutput) SetHasMoreDeliveryStreams(v bool) *ListDeliveryStreamsOutput
SetHasMoreDeliveryStreams sets the HasMoreDeliveryStreams field's value.
func (s ListDeliveryStreamsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForDeliveryStreamInput struct { // The name of the delivery stream whose tags you want to list. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The key to use as the starting point for the list of tags. If you set this // parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey. ExclusiveStartTagKey *string `min:"1" type:"string"` // The number of tags to return. If this number is less than the total number // of tags associated with the delivery stream, HasMoreTags is set to true in // the response. To list additional tags, set ExclusiveStartTagKey to the last // key in the response. Limit *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
func (s ListTagsForDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForDeliveryStreamInput) SetDeliveryStreamName(v string) *ListTagsForDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *ListTagsForDeliveryStreamInput) SetExclusiveStartTagKey(v string) *ListTagsForDeliveryStreamInput
SetExclusiveStartTagKey sets the ExclusiveStartTagKey field's value.
func (s *ListTagsForDeliveryStreamInput) SetLimit(v int64) *ListTagsForDeliveryStreamInput
SetLimit sets the Limit field's value.
func (s ListTagsForDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForDeliveryStreamOutput struct { // If this is true in the response, more tags are available. To list the remaining // tags, set ExclusiveStartTagKey to the key of the last tag returned and call // ListTagsForDeliveryStream again. // // HasMoreTags is a required field HasMoreTags *bool `type:"boolean" required:"true"` // A list of tags associated with DeliveryStreamName, starting with the first // tag after ExclusiveStartTagKey and up to the specified Limit. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListTagsForDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForDeliveryStreamOutput) SetHasMoreTags(v bool) *ListTagsForDeliveryStreamOutput
SetHasMoreTags sets the HasMoreTags field's value.
func (s *ListTagsForDeliveryStreamOutput) SetTags(v []*Tag) *ListTagsForDeliveryStreamOutput
SetTags sets the Tags field's value.
func (s ListTagsForDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MSKSourceConfiguration struct { // The authentication configuration of the Amazon MSK cluster. // // AuthenticationConfiguration is a required field AuthenticationConfiguration *AuthenticationConfiguration `type:"structure" required:"true"` // The ARN of the Amazon MSK cluster. // // MSKClusterARN is a required field MSKClusterARN *string `min:"1" type:"string" required:"true"` // The start date and time in UTC for the offset position within your MSK topic // from where Firehose begins to read. By default, this is set to timestamp // when Firehose becomes Active. // // If you want to create a Firehose stream with Earliest start position from // SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z). ReadFromTimestamp *time.Time `type:"timestamp"` // The topic name within the Amazon MSK cluster. // // TopicName is a required field TopicName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
func (s MSKSourceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MSKSourceConfiguration) SetAuthenticationConfiguration(v *AuthenticationConfiguration) *MSKSourceConfiguration
SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.
func (s *MSKSourceConfiguration) SetMSKClusterARN(v string) *MSKSourceConfiguration
SetMSKClusterARN sets the MSKClusterARN field's value.
func (s *MSKSourceConfiguration) SetReadFromTimestamp(v time.Time) *MSKSourceConfiguration
SetReadFromTimestamp sets the ReadFromTimestamp field's value.
func (s *MSKSourceConfiguration) SetTopicName(v string) *MSKSourceConfiguration
SetTopicName sets the TopicName field's value.
func (s MSKSourceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MSKSourceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MSKSourceDescription struct { // The authentication configuration of the Amazon MSK cluster. AuthenticationConfiguration *AuthenticationConfiguration `type:"structure"` // Firehose starts retrieving records from the topic within the Amazon MSK cluster // starting with this timestamp. DeliveryStartTimestamp *time.Time `type:"timestamp"` // The ARN of the Amazon MSK cluster. MSKClusterARN *string `min:"1" type:"string"` // The start date and time in UTC for the offset position within your MSK topic // from where Firehose begins to read. By default, this is set to timestamp // when Firehose becomes Active. // // If you want to create a Firehose stream with Earliest start position from // SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z). ReadFromTimestamp *time.Time `type:"timestamp"` // The topic name within the Amazon MSK cluster. TopicName *string `min:"1" type:"string"` // contains filtered or unexported fields }
Details about the Amazon MSK cluster used as the source for a Firehose delivery stream.
func (s MSKSourceDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MSKSourceDescription) SetAuthenticationConfiguration(v *AuthenticationConfiguration) *MSKSourceDescription
SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.
func (s *MSKSourceDescription) SetDeliveryStartTimestamp(v time.Time) *MSKSourceDescription
SetDeliveryStartTimestamp sets the DeliveryStartTimestamp field's value.
func (s *MSKSourceDescription) SetMSKClusterARN(v string) *MSKSourceDescription
SetMSKClusterARN sets the MSKClusterARN field's value.
func (s *MSKSourceDescription) SetReadFromTimestamp(v time.Time) *MSKSourceDescription
SetReadFromTimestamp sets the ReadFromTimestamp field's value.
func (s *MSKSourceDescription) SetTopicName(v string) *MSKSourceDescription
SetTopicName sets the TopicName field's value.
func (s MSKSourceDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type OpenXJsonSerDe struct { // When set to true, which is the default, Firehose converts JSON keys to lowercase // before deserializing them. CaseInsensitive *bool `type:"boolean"` // Maps column names to JSON keys that aren't identical to the column names. // This is useful when the JSON contains keys that are Hive keywords. For example, // timestamp is a Hive keyword. If you have a JSON key named timestamp, set // this parameter to {"ts": "timestamp"} to map this key to a column named ts. ColumnToJsonKeyMappings map[string]*string `type:"map"` // When set to true, specifies that the names of the keys include dots and that // you want Firehose to replace them with underscores. This is useful because // Apache Hive does not allow dots in column names. For example, if the JSON // contains a key whose name is "a.b", you can define the column name to be // "a_b" when using this option. // // The default is false. ConvertDotsInJsonKeysToUnderscores *bool `type:"boolean"` // contains filtered or unexported fields }
The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
func (s OpenXJsonSerDe) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OpenXJsonSerDe) SetCaseInsensitive(v bool) *OpenXJsonSerDe
SetCaseInsensitive sets the CaseInsensitive field's value.
func (s *OpenXJsonSerDe) SetColumnToJsonKeyMappings(v map[string]*string) *OpenXJsonSerDe
SetColumnToJsonKeyMappings sets the ColumnToJsonKeyMappings field's value.
func (s *OpenXJsonSerDe) SetConvertDotsInJsonKeysToUnderscores(v bool) *OpenXJsonSerDe
SetConvertDotsInJsonKeysToUnderscores sets the ConvertDotsInJsonKeysToUnderscores field's value.
func (s OpenXJsonSerDe) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type OrcSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you // intend to copy the data from Amazon S3 to HDFS before querying. The default // is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding // calculations. BlockSizeBytes *int64 `min:"6.7108864e+07" type:"integer"` // The column names for which you want Firehose to create bloom filters. The // default is null. BloomFilterColumns []*string `type:"list"` // The Bloom filter false positive probability (FPP). The lower the FPP, the // bigger the Bloom filter. The default value is 0.05, the minimum is 0, and // the maximum is 1. BloomFilterFalsePositiveProbability *float64 `type:"double"` // The compression code to use over data blocks. The default is SNAPPY. Compression *string `type:"string" enum:"OrcCompression"` // Represents the fraction of the total number of non-null rows. To turn off // dictionary encoding, set this fraction to a number that is less than the // number of distinct keys in a dictionary. To always use dictionary encoding, // set this threshold to 1. DictionaryKeyThreshold *float64 `type:"double"` // Set this to true to indicate that you want stripes to be padded to the HDFS // block boundaries. This is useful if you intend to copy the data from Amazon // S3 to HDFS before querying. The default is false. EnablePadding *bool `type:"boolean"` // The version of the file to write. The possible values are V0_11 and V0_12. // The default is V0_12. FormatVersion *string `type:"string" enum:"OrcFormatVersion"` // A number between 0 and 1 that defines the tolerance for block padding as // a decimal fraction of stripe size. The default value is 0.05, which means // 5 percent of stripe size. // // For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the // default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB // for padding within the 256 MiB block. In such a case, if the available size // within the block is more than 3.2 MiB, a new, smaller stripe is inserted // to fit within that space. This ensures that no stripe crosses block boundaries // and causes remote reads within a node-local task. // // Firehose ignores this parameter when OrcSerDe$EnablePadding is false. PaddingTolerance *float64 `type:"double"` // The number of rows between index entries. The default is 10,000 and the minimum // is 1,000. RowIndexStride *int64 `min:"1000" type:"integer"` // The number of bytes in each stripe. The default is 64 MiB and the minimum // is 8 MiB. StripeSizeBytes *int64 `min:"8.388608e+06" type:"integer"` // contains filtered or unexported fields }
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/).
func (s OrcSerDe) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OrcSerDe) SetBlockSizeBytes(v int64) *OrcSerDe
SetBlockSizeBytes sets the BlockSizeBytes field's value.
func (s *OrcSerDe) SetBloomFilterColumns(v []*string) *OrcSerDe
SetBloomFilterColumns sets the BloomFilterColumns field's value.
func (s *OrcSerDe) SetBloomFilterFalsePositiveProbability(v float64) *OrcSerDe
SetBloomFilterFalsePositiveProbability sets the BloomFilterFalsePositiveProbability field's value.
func (s *OrcSerDe) SetCompression(v string) *OrcSerDe
SetCompression sets the Compression field's value.
func (s *OrcSerDe) SetDictionaryKeyThreshold(v float64) *OrcSerDe
SetDictionaryKeyThreshold sets the DictionaryKeyThreshold field's value.
func (s *OrcSerDe) SetEnablePadding(v bool) *OrcSerDe
SetEnablePadding sets the EnablePadding field's value.
func (s *OrcSerDe) SetFormatVersion(v string) *OrcSerDe
SetFormatVersion sets the FormatVersion field's value.
func (s *OrcSerDe) SetPaddingTolerance(v float64) *OrcSerDe
SetPaddingTolerance sets the PaddingTolerance field's value.
func (s *OrcSerDe) SetRowIndexStride(v int64) *OrcSerDe
SetRowIndexStride sets the RowIndexStride field's value.
func (s *OrcSerDe) SetStripeSizeBytes(v int64) *OrcSerDe
SetStripeSizeBytes sets the StripeSizeBytes field's value.
func (s OrcSerDe) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OrcSerDe) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OutputFormatConfiguration struct { // Specifies which serializer to use. You can choose either the ORC SerDe or // the Parquet SerDe. If both are non-null, the server rejects the request. Serializer *Serializer `type:"structure"` // contains filtered or unexported fields }
Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
func (s OutputFormatConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OutputFormatConfiguration) SetSerializer(v *Serializer) *OutputFormatConfiguration
SetSerializer sets the Serializer field's value.
func (s OutputFormatConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OutputFormatConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ParquetSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you // intend to copy the data from Amazon S3 to HDFS before querying. The default // is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding // calculations. BlockSizeBytes *int64 `min:"6.7108864e+07" type:"integer"` // The compression code to use over data blocks. The possible values are UNCOMPRESSED, // SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression // speed. Use GZIP if the compression ratio is more important than speed. Compression *string `type:"string" enum:"ParquetCompression"` // Indicates whether to enable dictionary compression. EnableDictionaryCompression *bool `type:"boolean"` // The maximum amount of padding to apply. This is useful if you intend to copy // the data from Amazon S3 to HDFS before querying. The default is 0. MaxPaddingBytes *int64 `type:"integer"` // The Parquet page size. Column chunks are divided into pages. A page is conceptually // an indivisible unit (in terms of compression and encoding). The minimum value // is 64 KiB and the default is 1 MiB. PageSizeBytes *int64 `min:"65536" type:"integer"` // Indicates the version of row format to output. The possible values are V1 // and V2. The default is V1. WriterVersion *string `type:"string" enum:"ParquetWriterVersion"` // contains filtered or unexported fields }
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/docs/).
func (s ParquetSerDe) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ParquetSerDe) SetBlockSizeBytes(v int64) *ParquetSerDe
SetBlockSizeBytes sets the BlockSizeBytes field's value.
func (s *ParquetSerDe) SetCompression(v string) *ParquetSerDe
SetCompression sets the Compression field's value.
func (s *ParquetSerDe) SetEnableDictionaryCompression(v bool) *ParquetSerDe
SetEnableDictionaryCompression sets the EnableDictionaryCompression field's value.
func (s *ParquetSerDe) SetMaxPaddingBytes(v int64) *ParquetSerDe
SetMaxPaddingBytes sets the MaxPaddingBytes field's value.
func (s *ParquetSerDe) SetPageSizeBytes(v int64) *ParquetSerDe
SetPageSizeBytes sets the PageSizeBytes field's value.
func (s *ParquetSerDe) SetWriterVersion(v string) *ParquetSerDe
SetWriterVersion sets the WriterVersion field's value.
func (s ParquetSerDe) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ParquetSerDe) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProcessingConfiguration struct { // Enables or disables data processing. Enabled *bool `type:"boolean"` // The data processors. Processors []*Processor `type:"list"` // contains filtered or unexported fields }
Describes a data processing configuration.
func (s ProcessingConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ProcessingConfiguration) SetEnabled(v bool) *ProcessingConfiguration
SetEnabled sets the Enabled field's value.
func (s *ProcessingConfiguration) SetProcessors(v []*Processor) *ProcessingConfiguration
SetProcessors sets the Processors field's value.
func (s ProcessingConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ProcessingConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Processor struct { // The processor parameters. Parameters []*ProcessorParameter `type:"list"` // The type of processor. // // Type is a required field Type *string `type:"string" required:"true" enum:"ProcessorType"` // contains filtered or unexported fields }
Describes a data processor.
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord.
func (s Processor) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Processor) SetParameters(v []*ProcessorParameter) *Processor
SetParameters sets the Parameters field's value.
func (s *Processor) SetType(v string) *Processor
SetType sets the Type field's value.
func (s Processor) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Processor) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProcessorParameter struct { // The name of the parameter. Currently the following default values are supported: // 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs // ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for // all destinations, except Splunk. For Splunk, the default buffering hint is // 256 KB. // // ParameterName is a required field ParameterName *string `type:"string" required:"true" enum:"ProcessorParameterName"` // The parameter value. // // ParameterValue is a required field ParameterValue *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the processor parameter.
func (s ProcessorParameter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ProcessorParameter) SetParameterName(v string) *ProcessorParameter
SetParameterName sets the ParameterName field's value.
func (s *ProcessorParameter) SetParameterValue(v string) *ProcessorParameter
SetParameterValue sets the ParameterValue field's value.
func (s ProcessorParameter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ProcessorParameter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRecordBatchInput struct { // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // One or more records. // // Records is a required field Records []*Record `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s PutRecordBatchInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordBatchInput) SetDeliveryStreamName(v string) *PutRecordBatchInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *PutRecordBatchInput) SetRecords(v []*Record) *PutRecordBatchInput
SetRecords sets the Records field's value.
func (s PutRecordBatchInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRecordBatchOutput struct { // Indicates whether server-side encryption (SSE) was enabled during this operation. Encrypted *bool `type:"boolean"` // The number of records that might have failed processing. This number might // be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount // to determine whether there are records that you need to resend. // // FailedPutCount is a required field FailedPutCount *int64 `type:"integer" required:"true"` // The results array. For each record, the index of the response element is // the same as the index used in the request array. // // RequestResponses is a required field RequestResponses []*PutRecordBatchResponseEntry `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s PutRecordBatchOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordBatchOutput) SetEncrypted(v bool) *PutRecordBatchOutput
SetEncrypted sets the Encrypted field's value.
func (s *PutRecordBatchOutput) SetFailedPutCount(v int64) *PutRecordBatchOutput
SetFailedPutCount sets the FailedPutCount field's value.
func (s *PutRecordBatchOutput) SetRequestResponses(v []*PutRecordBatchResponseEntry) *PutRecordBatchOutput
SetRequestResponses sets the RequestResponses field's value.
func (s PutRecordBatchOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PutRecordBatchResponseEntry struct { // The error code for an individual record result. ErrorCode *string `type:"string"` // The error message for an individual record result. ErrorMessage *string `type:"string"` // The ID of the record. RecordId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.
func (s PutRecordBatchResponseEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordBatchResponseEntry) SetErrorCode(v string) *PutRecordBatchResponseEntry
SetErrorCode sets the ErrorCode field's value.
func (s *PutRecordBatchResponseEntry) SetErrorMessage(v string) *PutRecordBatchResponseEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s *PutRecordBatchResponseEntry) SetRecordId(v string) *PutRecordBatchResponseEntry
SetRecordId sets the RecordId field's value.
func (s PutRecordBatchResponseEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PutRecordInput struct { // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The record. // // Record is a required field Record *Record `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s PutRecordInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordInput) SetDeliveryStreamName(v string) *PutRecordInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *PutRecordInput) SetRecord(v *Record) *PutRecordInput
SetRecord sets the Record field's value.
func (s PutRecordInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRecordOutput struct { // Indicates whether server-side encryption (SSE) was enabled during this operation. Encrypted *bool `type:"boolean"` // The ID of the record. // // RecordId is a required field RecordId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s PutRecordOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutRecordOutput) SetEncrypted(v bool) *PutRecordOutput
SetEncrypted sets the Encrypted field's value.
func (s *PutRecordOutput) SetRecordId(v string) *PutRecordOutput
SetRecordId sets the RecordId field's value.
func (s PutRecordOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Record struct { // The data blob, which is base64-encoded when the blob is serialized. The maximum // size of the data blob, before base64-encoding, is 1,000 KiB. // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `type:"blob" required:"true"` // contains filtered or unexported fields }
The unit of data in a delivery stream.
func (s Record) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Record) SetData(v []byte) *Record
SetData sets the Data field's value.
func (s Record) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Record) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RedshiftDestinationConfiguration struct { // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The database connection string. // // ClusterJDBCURL is a required field ClusterJDBCURL *string `min:"1" type:"string" required:"true"` // The COPY command. // // CopyCommand is a required field CopyCommand *CopyCommand `type:"structure" required:"true"` // The user password. // // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationConfiguration's // String and GoString methods. Password *string `min:"6" type:"string" sensitive:"true"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // Redshift. Default value is 3600 (60 minutes). RetryOptions *RedshiftRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The configuration for backup in Amazon S3. S3BackupConfiguration *S3DestinationConfiguration `type:"structure"` // The Amazon S3 backup mode. After you create a delivery stream, you can update // it to enable Amazon S3 backup if it is disabled. If backup is enabled, you // can't update the delivery stream to disable it. S3BackupMode *string `type:"string" enum:"RedshiftS3BackupMode"` // The configuration for the intermediate Amazon S3 location from which Amazon // Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream. // // The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration // because the Amazon Redshift COPY operation that reads from the S3 bucket // doesn't support these compression formats. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The configuration that defines how you access secrets for Amazon Redshift. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // The name of the user. // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationConfiguration's // String and GoString methods. Username *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Describes the configuration of a destination in Amazon Redshift.
func (s RedshiftDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *RedshiftDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *RedshiftDestinationConfiguration) SetClusterJDBCURL(v string) *RedshiftDestinationConfiguration
SetClusterJDBCURL sets the ClusterJDBCURL field's value.
func (s *RedshiftDestinationConfiguration) SetCopyCommand(v *CopyCommand) *RedshiftDestinationConfiguration
SetCopyCommand sets the CopyCommand field's value.
func (s *RedshiftDestinationConfiguration) SetPassword(v string) *RedshiftDestinationConfiguration
SetPassword sets the Password field's value.
func (s *RedshiftDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *RedshiftDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *RedshiftDestinationConfiguration) SetRetryOptions(v *RedshiftRetryOptions) *RedshiftDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *RedshiftDestinationConfiguration) SetRoleARN(v string) *RedshiftDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *RedshiftDestinationConfiguration) SetS3BackupConfiguration(v *S3DestinationConfiguration) *RedshiftDestinationConfiguration
SetS3BackupConfiguration sets the S3BackupConfiguration field's value.
func (s *RedshiftDestinationConfiguration) SetS3BackupMode(v string) *RedshiftDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *RedshiftDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *RedshiftDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *RedshiftDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationConfiguration
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *RedshiftDestinationConfiguration) SetUsername(v string) *RedshiftDestinationConfiguration
SetUsername sets the Username field's value.
func (s RedshiftDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RedshiftDestinationDescription struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The database connection string. // // ClusterJDBCURL is a required field ClusterJDBCURL *string `min:"1" type:"string" required:"true"` // The COPY command. // // CopyCommand is a required field CopyCommand *CopyCommand `type:"structure" required:"true"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // Redshift. Default value is 3600 (60 minutes). RetryOptions *RedshiftRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The configuration for backup in Amazon S3. S3BackupDescription *S3DestinationDescription `type:"structure"` // The Amazon S3 backup mode. S3BackupMode *string `type:"string" enum:"RedshiftS3BackupMode"` // The Amazon S3 destination. // // S3DestinationDescription is a required field S3DestinationDescription *S3DestinationDescription `type:"structure" required:"true"` // The configuration that defines how you access secrets for Amazon Redshift. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // The name of the user. // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationDescription's // String and GoString methods. Username *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Describes a destination in Amazon Redshift.
func (s RedshiftDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *RedshiftDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *RedshiftDestinationDescription) SetClusterJDBCURL(v string) *RedshiftDestinationDescription
SetClusterJDBCURL sets the ClusterJDBCURL field's value.
func (s *RedshiftDestinationDescription) SetCopyCommand(v *CopyCommand) *RedshiftDestinationDescription
SetCopyCommand sets the CopyCommand field's value.
func (s *RedshiftDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *RedshiftDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *RedshiftDestinationDescription) SetRetryOptions(v *RedshiftRetryOptions) *RedshiftDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *RedshiftDestinationDescription) SetRoleARN(v string) *RedshiftDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *RedshiftDestinationDescription) SetS3BackupDescription(v *S3DestinationDescription) *RedshiftDestinationDescription
SetS3BackupDescription sets the S3BackupDescription field's value.
func (s *RedshiftDestinationDescription) SetS3BackupMode(v string) *RedshiftDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *RedshiftDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *RedshiftDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *RedshiftDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationDescription
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *RedshiftDestinationDescription) SetUsername(v string) *RedshiftDestinationDescription
SetUsername sets the Username field's value.
func (s RedshiftDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RedshiftDestinationUpdate struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The database connection string. ClusterJDBCURL *string `min:"1" type:"string"` // The COPY command. CopyCommand *CopyCommand `type:"structure"` // The user password. // // Password is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationUpdate's // String and GoString methods. Password *string `min:"6" type:"string" sensitive:"true"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver documents to Amazon // Redshift. Default value is 3600 (60 minutes). RetryOptions *RedshiftRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string `min:"1" type:"string"` // You can update a delivery stream to enable Amazon S3 backup if it is disabled. // If backup is enabled, you can't update the delivery stream to disable it. S3BackupMode *string `type:"string" enum:"RedshiftS3BackupMode"` // The Amazon S3 destination for backup. S3BackupUpdate *S3DestinationUpdate `type:"structure"` // The Amazon S3 destination. // // The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update // because the Amazon Redshift COPY operation that reads from the S3 bucket // doesn't support these compression formats. S3Update *S3DestinationUpdate `type:"structure"` // The configuration that defines how you access secrets for Amazon Redshift. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // The name of the user. // // Username is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by RedshiftDestinationUpdate's // String and GoString methods. Username *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Describes an update for a destination in Amazon Redshift.
func (s RedshiftDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *RedshiftDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *RedshiftDestinationUpdate) SetClusterJDBCURL(v string) *RedshiftDestinationUpdate
SetClusterJDBCURL sets the ClusterJDBCURL field's value.
func (s *RedshiftDestinationUpdate) SetCopyCommand(v *CopyCommand) *RedshiftDestinationUpdate
SetCopyCommand sets the CopyCommand field's value.
func (s *RedshiftDestinationUpdate) SetPassword(v string) *RedshiftDestinationUpdate
SetPassword sets the Password field's value.
func (s *RedshiftDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *RedshiftDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *RedshiftDestinationUpdate) SetRetryOptions(v *RedshiftRetryOptions) *RedshiftDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *RedshiftDestinationUpdate) SetRoleARN(v string) *RedshiftDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *RedshiftDestinationUpdate) SetS3BackupMode(v string) *RedshiftDestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *RedshiftDestinationUpdate) SetS3BackupUpdate(v *S3DestinationUpdate) *RedshiftDestinationUpdate
SetS3BackupUpdate sets the S3BackupUpdate field's value.
func (s *RedshiftDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *RedshiftDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *RedshiftDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *RedshiftDestinationUpdate
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *RedshiftDestinationUpdate) SetUsername(v string) *RedshiftDestinationUpdate
SetUsername sets the Username field's value.
func (s RedshiftDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RedshiftRetryOptions struct { // The length of time during which Firehose retries delivery after a failure, // starting from the initial request and including the first attempt. The default // value is 3600 seconds (60 minutes). Firehose does not retry if the value // of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer // than the current value. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
func (s RedshiftRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RedshiftRetryOptions) SetDurationInSeconds(v int64) *RedshiftRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s RedshiftRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceInUseException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The resource is already in use and not available for this operation.
func (s *ResourceInUseException) Code() string
Code returns the exception type name.
func (s *ResourceInUseException) Error() string
func (s ResourceInUseException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceInUseException) Message() string
Message returns the exception's message.
func (s *ResourceInUseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceInUseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceInUseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceInUseException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified resource could not be found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RetryOptions struct { // The period of time during which Firehose retries to deliver data to the specified // Amazon S3 prefix. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
func (s RetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RetryOptions) SetDurationInSeconds(v int64) *RetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s RetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type S3DestinationConfiguration struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // The buffering option. If no value is specified, BufferingHints object default // values are used. BufferingHints *BufferingHints `type:"structure"` // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // 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. CompressionFormat *string `type:"string" enum:"CompressionFormat"` // The encryption configuration. If no value is specified, the default is no // encryption. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the configuration of a destination in Amazon S3.
func (s S3DestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationConfiguration) SetBucketARN(v string) *S3DestinationConfiguration
SetBucketARN sets the BucketARN field's value.
func (s *S3DestinationConfiguration) SetBufferingHints(v *BufferingHints) *S3DestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *S3DestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *S3DestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *S3DestinationConfiguration) SetCompressionFormat(v string) *S3DestinationConfiguration
SetCompressionFormat sets the CompressionFormat field's value.
func (s *S3DestinationConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *S3DestinationConfiguration
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *S3DestinationConfiguration) SetErrorOutputPrefix(v string) *S3DestinationConfiguration
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *S3DestinationConfiguration) SetPrefix(v string) *S3DestinationConfiguration
SetPrefix sets the Prefix field's value.
func (s *S3DestinationConfiguration) SetRoleARN(v string) *S3DestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s S3DestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3DestinationDescription struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // The buffering option. If no value is specified, BufferingHints object default // values are used. // // BufferingHints is a required field BufferingHints *BufferingHints `type:"structure" required:"true"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The compression format. If no value is specified, the default is UNCOMPRESSED. // // CompressionFormat is a required field CompressionFormat *string `type:"string" required:"true" enum:"CompressionFormat"` // The encryption configuration. If no value is specified, the default is no // encryption. // // EncryptionConfiguration is a required field EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes a destination in Amazon S3.
func (s S3DestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationDescription) SetBucketARN(v string) *S3DestinationDescription
SetBucketARN sets the BucketARN field's value.
func (s *S3DestinationDescription) SetBufferingHints(v *BufferingHints) *S3DestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *S3DestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *S3DestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *S3DestinationDescription) SetCompressionFormat(v string) *S3DestinationDescription
SetCompressionFormat sets the CompressionFormat field's value.
func (s *S3DestinationDescription) SetEncryptionConfiguration(v *EncryptionConfiguration) *S3DestinationDescription
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *S3DestinationDescription) SetErrorOutputPrefix(v string) *S3DestinationDescription
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *S3DestinationDescription) SetPrefix(v string) *S3DestinationDescription
SetPrefix sets the Prefix field's value.
func (s *S3DestinationDescription) SetRoleARN(v string) *S3DestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s S3DestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type S3DestinationUpdate struct { // The ARN of the S3 bucket. For more information, see Amazon Resource Names // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). BucketARN *string `min:"1" type:"string"` // The buffering option. If no value is specified, BufferingHints object default // values are used. BufferingHints *BufferingHints `type:"structure"` // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // 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. CompressionFormat *string `type:"string" enum:"CompressionFormat"` // The encryption configuration. If no value is specified, the default is no // encryption. EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // A prefix that Firehose evaluates and adds to failed records before writing // them to S3. This prefix appears immediately following the bucket name. For // information about how to specify this prefix, see Custom Prefixes for Amazon // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). ErrorOutputPrefix *string `type:"string"` // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). Prefix *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes an update for a destination in Amazon S3.
func (s S3DestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationUpdate) SetBucketARN(v string) *S3DestinationUpdate
SetBucketARN sets the BucketARN field's value.
func (s *S3DestinationUpdate) SetBufferingHints(v *BufferingHints) *S3DestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *S3DestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *S3DestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *S3DestinationUpdate) SetCompressionFormat(v string) *S3DestinationUpdate
SetCompressionFormat sets the CompressionFormat field's value.
func (s *S3DestinationUpdate) SetEncryptionConfiguration(v *EncryptionConfiguration) *S3DestinationUpdate
SetEncryptionConfiguration sets the EncryptionConfiguration field's value.
func (s *S3DestinationUpdate) SetErrorOutputPrefix(v string) *S3DestinationUpdate
SetErrorOutputPrefix sets the ErrorOutputPrefix field's value.
func (s *S3DestinationUpdate) SetPrefix(v string) *S3DestinationUpdate
SetPrefix sets the Prefix field's value.
func (s *S3DestinationUpdate) SetRoleARN(v string) *S3DestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s S3DestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3DestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SchemaConfiguration struct { // The ID of the Amazon Web Services Glue Data Catalog. If you don't supply // this, the Amazon Web Services account ID is used by default. CatalogId *string `min:"1" type:"string"` // Specifies the name of the Amazon Web Services Glue database that contains // the schema for the output data. // // If the SchemaConfiguration request parameter is used as part of invoking // the CreateDeliveryStream API, then the DatabaseName property is required // and its value must be specified. DatabaseName *string `min:"1" type:"string"` // If you don't specify an Amazon Web Services Region, the default is the current // Region. Region *string `min:"1" type:"string"` // The role that Firehose can use to access Amazon Web Services Glue. This role // must be in the same account you use for Firehose. Cross-account roles aren't // allowed. // // If the SchemaConfiguration request parameter is used as part of invoking // the CreateDeliveryStream API, then the RoleARN property is required and its // value must be specified. RoleARN *string `min:"1" type:"string"` // Specifies the Amazon Web Services Glue table that contains the column information // that constitutes your data schema. // // If the SchemaConfiguration request parameter is used as part of invoking // the CreateDeliveryStream API, then the TableName property is required and // its value must be specified. TableName *string `min:"1" type:"string"` // Specifies the table version for the output data schema. If you don't specify // this version ID, or if you set it to LATEST, Firehose uses the most recent // version. This means that any updates to the table are automatically picked // up. VersionId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
func (s SchemaConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SchemaConfiguration) SetCatalogId(v string) *SchemaConfiguration
SetCatalogId sets the CatalogId field's value.
func (s *SchemaConfiguration) SetDatabaseName(v string) *SchemaConfiguration
SetDatabaseName sets the DatabaseName field's value.
func (s *SchemaConfiguration) SetRegion(v string) *SchemaConfiguration
SetRegion sets the Region field's value.
func (s *SchemaConfiguration) SetRoleARN(v string) *SchemaConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *SchemaConfiguration) SetTableName(v string) *SchemaConfiguration
SetTableName sets the TableName field's value.
func (s *SchemaConfiguration) SetVersionId(v string) *SchemaConfiguration
SetVersionId sets the VersionId field's value.
func (s SchemaConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SchemaConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SecretsManagerConfiguration struct { // Specifies whether you want to use the the secrets manager feature. When set // as True the secrets manager configuration overwrites the existing secrets // in the destination configuration. When it's set to False Firehose falls back // to the credentials in the destination configuration. // // Enabled is a required field Enabled *bool `type:"boolean" required:"true"` // Specifies the role that Firehose assumes when calling the Secrets Manager // API operation. When you provide the role, it overrides any destination specific // role defined in the destination configuration. If you do not provide the // then we use the destination specific role. This parameter is required for // Splunk. RoleARN *string `min:"1" type:"string"` // The ARN of the secret that stores your credentials. It must be in the same // region as the Firehose stream and the role. The secret ARN can reside in // a different account than the delivery stream and role as Firehose supports // cross-account secret access. This parameter is required when Enabled is set // to True. SecretARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
The structure that defines how Firehose accesses the secret.
func (s SecretsManagerConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SecretsManagerConfiguration) SetEnabled(v bool) *SecretsManagerConfiguration
SetEnabled sets the Enabled field's value.
func (s *SecretsManagerConfiguration) SetRoleARN(v string) *SecretsManagerConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *SecretsManagerConfiguration) SetSecretARN(v string) *SecretsManagerConfiguration
SetSecretARN sets the SecretARN field's value.
func (s SecretsManagerConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SecretsManagerConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Serializer struct { // A serializer to use for converting data to the ORC format before storing // it in Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/). OrcSerDe *OrcSerDe `type:"structure"` // A serializer to use for converting data to the Parquet format before storing // it in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/documentation/latest/). ParquetSerDe *ParquetSerDe `type:"structure"` // contains filtered or unexported fields }
The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html) and the Parquet SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html).
func (s Serializer) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Serializer) SetOrcSerDe(v *OrcSerDe) *Serializer
SetOrcSerDe sets the OrcSerDe field's value.
func (s *Serializer) SetParquetSerDe(v *ParquetSerDe) *Serializer
SetParquetSerDe sets the ParquetSerDe field's value.
func (s Serializer) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Serializer) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceUnavailableException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A message that provides information about the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html).
func (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
func (s ServiceUnavailableException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceUnavailableException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SnowflakeBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 0. IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 1. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
func (s SnowflakeBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeBufferingHints) SetIntervalInSeconds(v int64) *SnowflakeBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *SnowflakeBufferingHints) SetSizeInMBs(v int64) *SnowflakeBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s SnowflakeBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SnowflakeDestinationConfiguration struct { // URL for accessing your Snowflake account. This URL must include your account // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier). // Note that the protocol (https://) and port number are optional. // // AccountUrl is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. // // AccountUrl is a required field AccountUrl *string `min:"24" type:"string" required:"true" sensitive:"true"` // Describes the buffering to perform before delivering data to the Snowflake // destination. If you do not specify any value, Firehose uses the default values. BufferingHints *SnowflakeBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The name of the record content column // // ContentColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. ContentColumnName *string `min:"1" type:"string" sensitive:"true"` // Choose to load JSON keys mapped to table column names or choose to split // the JSON payload where content is mapped to a record content column and source // metadata is mapped to a record metadata column. DataLoadingOption *string `type:"string" enum:"SnowflakeDataLoadingOption"` // All data in Snowflake is maintained in databases. // // Database is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. // // Database is a required field Database *string `min:"1" type:"string" required:"true" sensitive:"true"` // Passphrase to decrypt the private key when the key is encrypted. For information, // see Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation). // // KeyPassphrase is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. KeyPassphrase *string `min:"7" type:"string" sensitive:"true"` // The name of the record metadata column // // MetaDataColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. MetaDataColumnName *string `min:"1" type:"string" sensitive:"true"` // The private key used to encrypt your Snowflake client. For information, see // Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation). // // PrivateKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. PrivateKey *string `min:"256" type:"string" sensitive:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The time period where Firehose will retry sending data to the chosen HTTP // endpoint. RetryOptions *SnowflakeRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Snowflake role // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // Choose an S3 backup mode S3BackupMode *string `type:"string" enum:"SnowflakeS3BackupMode"` // Describes the configuration of a destination in Amazon S3. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // Each database consists of one or more schemas, which are logical groupings // of database objects, such as tables and views // // Schema is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. // // Schema is a required field Schema *string `min:"1" type:"string" required:"true" sensitive:"true"` // The configuration that defines how you access secrets for Snowflake. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` // The VPCE ID for Firehose to privately connect with Snowflake. The ID format // is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see // Amazon PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) SnowflakeVpcConfiguration *SnowflakeVpcConfiguration `type:"structure"` // All data in Snowflake is stored in database tables, logically structured // as collections of columns and rows. // // Table is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. // // Table is a required field Table *string `min:"1" type:"string" required:"true" sensitive:"true"` // User login name for the Snowflake account. // // User is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationConfiguration's // String and GoString methods. User *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Configure Snowflake destination
func (s SnowflakeDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeDestinationConfiguration) SetAccountUrl(v string) *SnowflakeDestinationConfiguration
SetAccountUrl sets the AccountUrl field's value.
func (s *SnowflakeDestinationConfiguration) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *SnowflakeDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SnowflakeDestinationConfiguration) SetContentColumnName(v string) *SnowflakeDestinationConfiguration
SetContentColumnName sets the ContentColumnName field's value.
func (s *SnowflakeDestinationConfiguration) SetDataLoadingOption(v string) *SnowflakeDestinationConfiguration
SetDataLoadingOption sets the DataLoadingOption field's value.
func (s *SnowflakeDestinationConfiguration) SetDatabase(v string) *SnowflakeDestinationConfiguration
SetDatabase sets the Database field's value.
func (s *SnowflakeDestinationConfiguration) SetKeyPassphrase(v string) *SnowflakeDestinationConfiguration
SetKeyPassphrase sets the KeyPassphrase field's value.
func (s *SnowflakeDestinationConfiguration) SetMetaDataColumnName(v string) *SnowflakeDestinationConfiguration
SetMetaDataColumnName sets the MetaDataColumnName field's value.
func (s *SnowflakeDestinationConfiguration) SetPrivateKey(v string) *SnowflakeDestinationConfiguration
SetPrivateKey sets the PrivateKey field's value.
func (s *SnowflakeDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *SnowflakeDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SnowflakeDestinationConfiguration) SetRetryOptions(v *SnowflakeRetryOptions) *SnowflakeDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *SnowflakeDestinationConfiguration) SetRoleARN(v string) *SnowflakeDestinationConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *SnowflakeDestinationConfiguration) SetS3BackupMode(v string) *SnowflakeDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SnowflakeDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *SnowflakeDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *SnowflakeDestinationConfiguration) SetSchema(v string) *SnowflakeDestinationConfiguration
SetSchema sets the Schema field's value.
func (s *SnowflakeDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationConfiguration
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *SnowflakeDestinationConfiguration) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationConfiguration
SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value.
func (s *SnowflakeDestinationConfiguration) SetSnowflakeVpcConfiguration(v *SnowflakeVpcConfiguration) *SnowflakeDestinationConfiguration
SetSnowflakeVpcConfiguration sets the SnowflakeVpcConfiguration field's value.
func (s *SnowflakeDestinationConfiguration) SetTable(v string) *SnowflakeDestinationConfiguration
SetTable sets the Table field's value.
func (s *SnowflakeDestinationConfiguration) SetUser(v string) *SnowflakeDestinationConfiguration
SetUser sets the User field's value.
func (s SnowflakeDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SnowflakeDestinationDescription struct { // URL for accessing your Snowflake account. This URL must include your account // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier). // Note that the protocol (https://) and port number are optional. // // AccountUrl is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. AccountUrl *string `min:"24" type:"string" sensitive:"true"` // Describes the buffering to perform before delivering data to the Snowflake // destination. If you do not specify any value, Firehose uses the default values. BufferingHints *SnowflakeBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The name of the record content column // // ContentColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. ContentColumnName *string `min:"1" type:"string" sensitive:"true"` // Choose to load JSON keys mapped to table column names or choose to split // the JSON payload where content is mapped to a record content column and source // metadata is mapped to a record metadata column. DataLoadingOption *string `type:"string" enum:"SnowflakeDataLoadingOption"` // All data in Snowflake is maintained in databases. // // Database is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. Database *string `min:"1" type:"string" sensitive:"true"` // The name of the record metadata column // // MetaDataColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. MetaDataColumnName *string `min:"1" type:"string" sensitive:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The time period where Firehose will retry sending data to the chosen HTTP // endpoint. RetryOptions *SnowflakeRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Snowflake role RoleARN *string `min:"1" type:"string"` // Choose an S3 backup mode S3BackupMode *string `type:"string" enum:"SnowflakeS3BackupMode"` // Describes a destination in Amazon S3. S3DestinationDescription *S3DestinationDescription `type:"structure"` // Each database consists of one or more schemas, which are logical groupings // of database objects, such as tables and views // // Schema is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. Schema *string `min:"1" type:"string" sensitive:"true"` // The configuration that defines how you access secrets for Snowflake. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` // The VPCE ID for Firehose to privately connect with Snowflake. The ID format // is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see // Amazon PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) SnowflakeVpcConfiguration *SnowflakeVpcConfiguration `type:"structure"` // All data in Snowflake is stored in database tables, logically structured // as collections of columns and rows. // // Table is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. Table *string `min:"1" type:"string" sensitive:"true"` // User login name for the Snowflake account. // // User is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationDescription's // String and GoString methods. User *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Optional Snowflake destination description
func (s SnowflakeDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeDestinationDescription) SetAccountUrl(v string) *SnowflakeDestinationDescription
SetAccountUrl sets the AccountUrl field's value.
func (s *SnowflakeDestinationDescription) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *SnowflakeDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SnowflakeDestinationDescription) SetContentColumnName(v string) *SnowflakeDestinationDescription
SetContentColumnName sets the ContentColumnName field's value.
func (s *SnowflakeDestinationDescription) SetDataLoadingOption(v string) *SnowflakeDestinationDescription
SetDataLoadingOption sets the DataLoadingOption field's value.
func (s *SnowflakeDestinationDescription) SetDatabase(v string) *SnowflakeDestinationDescription
SetDatabase sets the Database field's value.
func (s *SnowflakeDestinationDescription) SetMetaDataColumnName(v string) *SnowflakeDestinationDescription
SetMetaDataColumnName sets the MetaDataColumnName field's value.
func (s *SnowflakeDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *SnowflakeDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SnowflakeDestinationDescription) SetRetryOptions(v *SnowflakeRetryOptions) *SnowflakeDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *SnowflakeDestinationDescription) SetRoleARN(v string) *SnowflakeDestinationDescription
SetRoleARN sets the RoleARN field's value.
func (s *SnowflakeDestinationDescription) SetS3BackupMode(v string) *SnowflakeDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SnowflakeDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *SnowflakeDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *SnowflakeDestinationDescription) SetSchema(v string) *SnowflakeDestinationDescription
SetSchema sets the Schema field's value.
func (s *SnowflakeDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationDescription
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *SnowflakeDestinationDescription) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationDescription
SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value.
func (s *SnowflakeDestinationDescription) SetSnowflakeVpcConfiguration(v *SnowflakeVpcConfiguration) *SnowflakeDestinationDescription
SetSnowflakeVpcConfiguration sets the SnowflakeVpcConfiguration field's value.
func (s *SnowflakeDestinationDescription) SetTable(v string) *SnowflakeDestinationDescription
SetTable sets the Table field's value.
func (s *SnowflakeDestinationDescription) SetUser(v string) *SnowflakeDestinationDescription
SetUser sets the User field's value.
func (s SnowflakeDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SnowflakeDestinationUpdate struct { // URL for accessing your Snowflake account. This URL must include your account // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier). // Note that the protocol (https://) and port number are optional. // // AccountUrl is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. AccountUrl *string `min:"24" type:"string" sensitive:"true"` // Describes the buffering to perform before delivering data to the Snowflake // destination. BufferingHints *SnowflakeBufferingHints `type:"structure"` // Describes the Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The name of the content metadata column // // ContentColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. ContentColumnName *string `min:"1" type:"string" sensitive:"true"` // JSON keys mapped to table column names or choose to split the JSON payload // where content is mapped to a record content column and source metadata is // mapped to a record metadata column. DataLoadingOption *string `type:"string" enum:"SnowflakeDataLoadingOption"` // All data in Snowflake is maintained in databases. // // Database is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. Database *string `min:"1" type:"string" sensitive:"true"` // Passphrase to decrypt the private key when the key is encrypted. For information, // see Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation). // // KeyPassphrase is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. KeyPassphrase *string `min:"7" type:"string" sensitive:"true"` // The name of the record metadata column // // MetaDataColumnName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. MetaDataColumnName *string `min:"1" type:"string" sensitive:"true"` // The private key used to encrypt your Snowflake client. For information, see // Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation). // // PrivateKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. PrivateKey *string `min:"256" type:"string" sensitive:"true"` // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // Specify how long Firehose retries sending data to the New Relic HTTP endpoint. // After sending data, Firehose first waits for an acknowledgment from the HTTP // endpoint. If an error occurs or the acknowledgment doesn’t arrive within // the acknowledgment timeout period, Firehose starts the retry duration counter. // It keeps retrying until the retry duration expires. After that, Firehose // considers it a data delivery failure and backs up the data to your Amazon // S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either // the initial attempt or a retry), it restarts the acknowledgement timeout // counter and waits for an acknowledgement from the HTTP endpoint. Even if // the retry duration expires, Firehose still waits for the acknowledgment until // it receives it or the acknowledgement timeout period is reached. If the acknowledgment // times out, Firehose determines whether there's time left in the retry counter. // If there is time left, it retries again and repeats the logic until it receives // an acknowledgment or determines that the retry time has expired. If you don't // want Firehose to retry sending data, set this value to 0. RetryOptions *SnowflakeRetryOptions `type:"structure"` // The Amazon Resource Name (ARN) of the Snowflake role RoleARN *string `min:"1" type:"string"` // Choose an S3 backup mode S3BackupMode *string `type:"string" enum:"SnowflakeS3BackupMode"` // Describes an update for a destination in Amazon S3. S3Update *S3DestinationUpdate `type:"structure"` // Each database consists of one or more schemas, which are logical groupings // of database objects, such as tables and views // // Schema is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. Schema *string `min:"1" type:"string" sensitive:"true"` // Describes the Secrets Manager configuration in Snowflake. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // Optionally configure a Snowflake role. Otherwise the default user role will // be used. SnowflakeRoleConfiguration *SnowflakeRoleConfiguration `type:"structure"` // All data in Snowflake is stored in database tables, logically structured // as collections of columns and rows. // // Table is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. Table *string `min:"1" type:"string" sensitive:"true"` // User login name for the Snowflake account. // // User is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeDestinationUpdate's // String and GoString methods. User *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Update to configuration settings
func (s SnowflakeDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeDestinationUpdate) SetAccountUrl(v string) *SnowflakeDestinationUpdate
SetAccountUrl sets the AccountUrl field's value.
func (s *SnowflakeDestinationUpdate) SetBufferingHints(v *SnowflakeBufferingHints) *SnowflakeDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *SnowflakeDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SnowflakeDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SnowflakeDestinationUpdate) SetContentColumnName(v string) *SnowflakeDestinationUpdate
SetContentColumnName sets the ContentColumnName field's value.
func (s *SnowflakeDestinationUpdate) SetDataLoadingOption(v string) *SnowflakeDestinationUpdate
SetDataLoadingOption sets the DataLoadingOption field's value.
func (s *SnowflakeDestinationUpdate) SetDatabase(v string) *SnowflakeDestinationUpdate
SetDatabase sets the Database field's value.
func (s *SnowflakeDestinationUpdate) SetKeyPassphrase(v string) *SnowflakeDestinationUpdate
SetKeyPassphrase sets the KeyPassphrase field's value.
func (s *SnowflakeDestinationUpdate) SetMetaDataColumnName(v string) *SnowflakeDestinationUpdate
SetMetaDataColumnName sets the MetaDataColumnName field's value.
func (s *SnowflakeDestinationUpdate) SetPrivateKey(v string) *SnowflakeDestinationUpdate
SetPrivateKey sets the PrivateKey field's value.
func (s *SnowflakeDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *SnowflakeDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SnowflakeDestinationUpdate) SetRetryOptions(v *SnowflakeRetryOptions) *SnowflakeDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *SnowflakeDestinationUpdate) SetRoleARN(v string) *SnowflakeDestinationUpdate
SetRoleARN sets the RoleARN field's value.
func (s *SnowflakeDestinationUpdate) SetS3BackupMode(v string) *SnowflakeDestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SnowflakeDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *SnowflakeDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *SnowflakeDestinationUpdate) SetSchema(v string) *SnowflakeDestinationUpdate
SetSchema sets the Schema field's value.
func (s *SnowflakeDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SnowflakeDestinationUpdate
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s *SnowflakeDestinationUpdate) SetSnowflakeRoleConfiguration(v *SnowflakeRoleConfiguration) *SnowflakeDestinationUpdate
SetSnowflakeRoleConfiguration sets the SnowflakeRoleConfiguration field's value.
func (s *SnowflakeDestinationUpdate) SetTable(v string) *SnowflakeDestinationUpdate
SetTable sets the Table field's value.
func (s *SnowflakeDestinationUpdate) SetUser(v string) *SnowflakeDestinationUpdate
SetUser sets the User field's value.
func (s SnowflakeDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SnowflakeRetryOptions struct { // the time period where Firehose will retry sending data to the chosen HTTP // endpoint. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
func (s SnowflakeRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeRetryOptions) SetDurationInSeconds(v int64) *SnowflakeRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s SnowflakeRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SnowflakeRoleConfiguration struct { // Enable Snowflake role Enabled *bool `type:"boolean"` // The Snowflake role you wish to configure // // SnowflakeRole is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeRoleConfiguration's // String and GoString methods. SnowflakeRole *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Optionally configure a Snowflake role. Otherwise the default user role will be used.
func (s SnowflakeRoleConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeRoleConfiguration) SetEnabled(v bool) *SnowflakeRoleConfiguration
SetEnabled sets the Enabled field's value.
func (s *SnowflakeRoleConfiguration) SetSnowflakeRole(v string) *SnowflakeRoleConfiguration
SetSnowflakeRole sets the SnowflakeRole field's value.
func (s SnowflakeRoleConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeRoleConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SnowflakeVpcConfiguration struct { // The VPCE ID for Firehose to privately connect with Snowflake. The ID format // is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see // Amazon PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) // // PrivateLinkVpceId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SnowflakeVpcConfiguration's // String and GoString methods. // // PrivateLinkVpceId is a required field PrivateLinkVpceId *string `min:"47" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
Configure a Snowflake VPC
func (s SnowflakeVpcConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeVpcConfiguration) SetPrivateLinkVpceId(v string) *SnowflakeVpcConfiguration
SetPrivateLinkVpceId sets the PrivateLinkVpceId field's value.
func (s SnowflakeVpcConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowflakeVpcConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SourceDescription struct { // The KinesisStreamSourceDescription value for the source Kinesis data stream. KinesisStreamSourceDescription *KinesisStreamSourceDescription `type:"structure"` // The configuration description for the Amazon MSK cluster to be used as the // source for a delivery stream. MSKSourceDescription *MSKSourceDescription `type:"structure"` // contains filtered or unexported fields }
Details about a Kinesis data stream used as the source for a Firehose delivery stream.
func (s SourceDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SourceDescription) SetKinesisStreamSourceDescription(v *KinesisStreamSourceDescription) *SourceDescription
SetKinesisStreamSourceDescription sets the KinesisStreamSourceDescription field's value.
func (s *SourceDescription) SetMSKSourceDescription(v *MSKSourceDescription) *SourceDescription
SetMSKSourceDescription sets the MSKSourceDescription field's value.
func (s SourceDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SplunkBufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 60 (1 minute). IntervalInSeconds *int64 `type:"integer"` // Buffer incoming data to the specified size, in MBs, before delivering it // to the destination. The default value is 5. SizeInMBs *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
The buffering options. If no value is specified, the default values for Splunk are used.
func (s SplunkBufferingHints) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkBufferingHints) SetIntervalInSeconds(v int64) *SplunkBufferingHints
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *SplunkBufferingHints) SetSizeInMBs(v int64) *SplunkBufferingHints
SetSizeInMBs sets the SizeInMBs field's value.
func (s SplunkBufferingHints) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkBufferingHints) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SplunkDestinationConfiguration struct { // The buffering options. If no value is specified, the default values for Splunk // are used. BufferingHints *SplunkBufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The amount of time that Firehose waits to receive an acknowledgment from // Splunk after it sends it data. At the end of the timeout period, Firehose // either tries to send the data again or considers it an error, based on your // retry settings. HECAcknowledgmentTimeoutInSeconds *int64 `min:"180" type:"integer"` // The HTTP Event Collector (HEC) endpoint to which Firehose sends your data. // // HECEndpoint is a required field HECEndpoint *string `type:"string" required:"true"` // This type can be either "Raw" or "Event." // // HECEndpointType is a required field HECEndpointType *string `type:"string" required:"true" enum:"HECEndpointType"` // This is a GUID that you obtain from your Splunk cluster when you create a // new HEC endpoint. HECToken *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to Splunk, // or if it doesn't receive an acknowledgment of receipt from Splunk. RetryOptions *SplunkRetryOptions `type:"structure"` // Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, // Firehose writes any data that could not be indexed to the configured Amazon // S3 destination. When set to AllEvents, Firehose delivers all incoming records // to Amazon S3, and also writes failed documents to Amazon S3. The default // value is FailedEventsOnly. // // You can update this backup mode from FailedEventsOnly to AllEvents. You can't // update it from AllEvents to FailedEventsOnly. S3BackupMode *string `type:"string" enum:"SplunkS3BackupMode"` // The configuration for the backup Amazon S3 location. // // S3Configuration is a required field S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` // The configuration that defines how you access secrets for Splunk. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes the configuration of a destination in Splunk.
func (s SplunkDestinationConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkDestinationConfiguration) SetBufferingHints(v *SplunkBufferingHints) *SplunkDestinationConfiguration
SetBufferingHints sets the BufferingHints field's value.
func (s *SplunkDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SplunkDestinationConfiguration
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SplunkDestinationConfiguration) SetHECAcknowledgmentTimeoutInSeconds(v int64) *SplunkDestinationConfiguration
SetHECAcknowledgmentTimeoutInSeconds sets the HECAcknowledgmentTimeoutInSeconds field's value.
func (s *SplunkDestinationConfiguration) SetHECEndpoint(v string) *SplunkDestinationConfiguration
SetHECEndpoint sets the HECEndpoint field's value.
func (s *SplunkDestinationConfiguration) SetHECEndpointType(v string) *SplunkDestinationConfiguration
SetHECEndpointType sets the HECEndpointType field's value.
func (s *SplunkDestinationConfiguration) SetHECToken(v string) *SplunkDestinationConfiguration
SetHECToken sets the HECToken field's value.
func (s *SplunkDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *SplunkDestinationConfiguration
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SplunkDestinationConfiguration) SetRetryOptions(v *SplunkRetryOptions) *SplunkDestinationConfiguration
SetRetryOptions sets the RetryOptions field's value.
func (s *SplunkDestinationConfiguration) SetS3BackupMode(v string) *SplunkDestinationConfiguration
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SplunkDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *SplunkDestinationConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (s *SplunkDestinationConfiguration) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationConfiguration
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s SplunkDestinationConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkDestinationConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SplunkDestinationDescription struct { // The buffering options. If no value is specified, the default values for Splunk // are used. BufferingHints *SplunkBufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The amount of time that Firehose waits to receive an acknowledgment from // Splunk after it sends it data. At the end of the timeout period, Firehose // either tries to send the data again or considers it an error, based on your // retry settings. HECAcknowledgmentTimeoutInSeconds *int64 `min:"180" type:"integer"` // The HTTP Event Collector (HEC) endpoint to which Firehose sends your data. HECEndpoint *string `type:"string"` // This type can be either "Raw" or "Event." HECEndpointType *string `type:"string" enum:"HECEndpointType"` // A GUID you obtain from your Splunk cluster when you create a new HEC endpoint. HECToken *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to Splunk or // if it doesn't receive an acknowledgment of receipt from Splunk. RetryOptions *SplunkRetryOptions `type:"structure"` // Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, // Firehose writes any data that could not be indexed to the configured Amazon // S3 destination. When set to AllDocuments, Firehose delivers all incoming // records to Amazon S3, and also writes failed documents to Amazon S3. Default // value is FailedDocumentsOnly. S3BackupMode *string `type:"string" enum:"SplunkS3BackupMode"` // The Amazon S3 destination.> S3DestinationDescription *S3DestinationDescription `type:"structure"` // The configuration that defines how you access secrets for Splunk. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes a destination in Splunk.
func (s SplunkDestinationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkDestinationDescription) SetBufferingHints(v *SplunkBufferingHints) *SplunkDestinationDescription
SetBufferingHints sets the BufferingHints field's value.
func (s *SplunkDestinationDescription) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SplunkDestinationDescription
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SplunkDestinationDescription) SetHECAcknowledgmentTimeoutInSeconds(v int64) *SplunkDestinationDescription
SetHECAcknowledgmentTimeoutInSeconds sets the HECAcknowledgmentTimeoutInSeconds field's value.
func (s *SplunkDestinationDescription) SetHECEndpoint(v string) *SplunkDestinationDescription
SetHECEndpoint sets the HECEndpoint field's value.
func (s *SplunkDestinationDescription) SetHECEndpointType(v string) *SplunkDestinationDescription
SetHECEndpointType sets the HECEndpointType field's value.
func (s *SplunkDestinationDescription) SetHECToken(v string) *SplunkDestinationDescription
SetHECToken sets the HECToken field's value.
func (s *SplunkDestinationDescription) SetProcessingConfiguration(v *ProcessingConfiguration) *SplunkDestinationDescription
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SplunkDestinationDescription) SetRetryOptions(v *SplunkRetryOptions) *SplunkDestinationDescription
SetRetryOptions sets the RetryOptions field's value.
func (s *SplunkDestinationDescription) SetS3BackupMode(v string) *SplunkDestinationDescription
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SplunkDestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *SplunkDestinationDescription
SetS3DestinationDescription sets the S3DestinationDescription field's value.
func (s *SplunkDestinationDescription) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationDescription
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s SplunkDestinationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SplunkDestinationUpdate struct { // The buffering options. If no value is specified, the default values for Splunk // are used. BufferingHints *SplunkBufferingHints `type:"structure"` // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` // The amount of time that Firehose waits to receive an acknowledgment from // Splunk after it sends data. At the end of the timeout period, Firehose either // tries to send the data again or considers it an error, based on your retry // settings. HECAcknowledgmentTimeoutInSeconds *int64 `min:"180" type:"integer"` // The HTTP Event Collector (HEC) endpoint to which Firehose sends your data. HECEndpoint *string `type:"string"` // This type can be either "Raw" or "Event." HECEndpointType *string `type:"string" enum:"HECEndpointType"` // A GUID that you obtain from your Splunk cluster when you create a new HEC // endpoint. HECToken *string `type:"string"` // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration `type:"structure"` // The retry behavior in case Firehose is unable to deliver data to Splunk or // if it doesn't receive an acknowledgment of receipt from Splunk. RetryOptions *SplunkRetryOptions `type:"structure"` // Specifies how you want Firehose to back up documents to Amazon S3. When set // to FailedDocumentsOnly, Firehose writes any data that could not be indexed // to the configured Amazon S3 destination. When set to AllEvents, Firehose // delivers all incoming records to Amazon S3, and also writes failed documents // to Amazon S3. The default value is FailedEventsOnly. // // You can update this backup mode from FailedEventsOnly to AllEvents. You can't // update it from AllEvents to FailedEventsOnly. S3BackupMode *string `type:"string" enum:"SplunkS3BackupMode"` // Your update to the configuration of the backup Amazon S3 location. S3Update *S3DestinationUpdate `type:"structure"` // The configuration that defines how you access secrets for Splunk. SecretsManagerConfiguration *SecretsManagerConfiguration `type:"structure"` // contains filtered or unexported fields }
Describes an update for a destination in Splunk.
func (s SplunkDestinationUpdate) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkDestinationUpdate) SetBufferingHints(v *SplunkBufferingHints) *SplunkDestinationUpdate
SetBufferingHints sets the BufferingHints field's value.
func (s *SplunkDestinationUpdate) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *SplunkDestinationUpdate
SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.
func (s *SplunkDestinationUpdate) SetHECAcknowledgmentTimeoutInSeconds(v int64) *SplunkDestinationUpdate
SetHECAcknowledgmentTimeoutInSeconds sets the HECAcknowledgmentTimeoutInSeconds field's value.
func (s *SplunkDestinationUpdate) SetHECEndpoint(v string) *SplunkDestinationUpdate
SetHECEndpoint sets the HECEndpoint field's value.
func (s *SplunkDestinationUpdate) SetHECEndpointType(v string) *SplunkDestinationUpdate
SetHECEndpointType sets the HECEndpointType field's value.
func (s *SplunkDestinationUpdate) SetHECToken(v string) *SplunkDestinationUpdate
SetHECToken sets the HECToken field's value.
func (s *SplunkDestinationUpdate) SetProcessingConfiguration(v *ProcessingConfiguration) *SplunkDestinationUpdate
SetProcessingConfiguration sets the ProcessingConfiguration field's value.
func (s *SplunkDestinationUpdate) SetRetryOptions(v *SplunkRetryOptions) *SplunkDestinationUpdate
SetRetryOptions sets the RetryOptions field's value.
func (s *SplunkDestinationUpdate) SetS3BackupMode(v string) *SplunkDestinationUpdate
SetS3BackupMode sets the S3BackupMode field's value.
func (s *SplunkDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *SplunkDestinationUpdate
SetS3Update sets the S3Update field's value.
func (s *SplunkDestinationUpdate) SetSecretsManagerConfiguration(v *SecretsManagerConfiguration) *SplunkDestinationUpdate
SetSecretsManagerConfiguration sets the SecretsManagerConfiguration field's value.
func (s SplunkDestinationUpdate) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkDestinationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SplunkRetryOptions struct { // The total amount of time that Firehose spends on retries. This duration starts // after the initial attempt to send data to Splunk fails. It doesn't include // the periods during which Firehose waits for acknowledgment from Splunk after // each attempt. DurationInSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
Configures retry behavior in case Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
func (s SplunkRetryOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SplunkRetryOptions) SetDurationInSeconds(v int64) *SplunkRetryOptions
SetDurationInSeconds sets the DurationInSeconds field's value.
func (s SplunkRetryOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StartDeliveryStreamEncryptionInput struct { // Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed // for Server-Side Encryption (SSE). DeliveryStreamEncryptionConfigurationInput *DeliveryStreamEncryptionConfigurationInput `type:"structure"` // The name of the delivery stream for which you want to enable server-side // encryption (SSE). // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s StartDeliveryStreamEncryptionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartDeliveryStreamEncryptionInput) SetDeliveryStreamEncryptionConfigurationInput(v *DeliveryStreamEncryptionConfigurationInput) *StartDeliveryStreamEncryptionInput
SetDeliveryStreamEncryptionConfigurationInput sets the DeliveryStreamEncryptionConfigurationInput field's value.
func (s *StartDeliveryStreamEncryptionInput) SetDeliveryStreamName(v string) *StartDeliveryStreamEncryptionInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s StartDeliveryStreamEncryptionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartDeliveryStreamEncryptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDeliveryStreamEncryptionOutput struct {
// contains filtered or unexported fields
}
func (s StartDeliveryStreamEncryptionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s StartDeliveryStreamEncryptionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StopDeliveryStreamEncryptionInput struct { // The name of the delivery stream for which you want to disable server-side // encryption (SSE). // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s StopDeliveryStreamEncryptionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StopDeliveryStreamEncryptionInput) SetDeliveryStreamName(v string) *StopDeliveryStreamEncryptionInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s StopDeliveryStreamEncryptionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StopDeliveryStreamEncryptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopDeliveryStreamEncryptionOutput struct {
// contains filtered or unexported fields
}
func (s StopDeliveryStreamEncryptionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s StopDeliveryStreamEncryptionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Tag struct { // A unique identifier for the tag. Maximum length: 128 characters. Valid characters: // Unicode letters, digits, white space, _ . / = + - % @ // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // An optional string, which you can use to describe or define the tag. Maximum // length: 256 characters. Valid characters: Unicode letters, digits, white // space, _ . / = + - % @ Value *string `type:"string"` // contains filtered or unexported fields }
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
func (s Tag) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Tag) SetKey(v string) *Tag
SetKey sets the Key field's value.
func (s *Tag) SetValue(v string) *Tag
SetValue sets the Value field's value.
func (s Tag) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagDeliveryStreamInput struct { // The name of the delivery stream to which you want to add the tags. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // A set of key-value pairs to use to create the tags. // // Tags is a required field Tags []*Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s TagDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagDeliveryStreamInput) SetDeliveryStreamName(v string) *TagDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *TagDeliveryStreamInput) SetTags(v []*Tag) *TagDeliveryStreamInput
SetTags sets the Tags field's value.
func (s TagDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagDeliveryStreamOutput struct {
// contains filtered or unexported fields
}
func (s TagDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s TagDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagDeliveryStreamInput struct { // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // A list of tag keys. Each corresponding tag is removed from the delivery stream. // // TagKeys is a required field TagKeys []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s UntagDeliveryStreamInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagDeliveryStreamInput) SetDeliveryStreamName(v string) *UntagDeliveryStreamInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *UntagDeliveryStreamInput) SetTagKeys(v []*string) *UntagDeliveryStreamInput
SetTagKeys sets the TagKeys field's value.
func (s UntagDeliveryStreamInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagDeliveryStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagDeliveryStreamOutput struct {
// contains filtered or unexported fields
}
func (s UntagDeliveryStreamOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UntagDeliveryStreamOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateDestinationInput struct { // Describes an update for a destination in the Serverless offering for Amazon // OpenSearch Service. AmazonOpenSearchServerlessDestinationUpdate *AmazonOpenSearchServerlessDestinationUpdate `type:"structure"` // Describes an update for a destination in Amazon OpenSearch Service. AmazonopensearchserviceDestinationUpdate *AmazonopensearchserviceDestinationUpdate `type:"structure"` // Obtain this value from the VersionId result of DeliveryStreamDescription. // This value is required, and helps the service perform conditional operations. // For example, if there is an interleaving update and this value is null, then // the update destination fails. After the update is successful, the VersionId // value is updated. The service then performs a merge of the old configuration // with the new configuration. // // CurrentDeliveryStreamVersionId is a required field CurrentDeliveryStreamVersionId *string `min:"1" type:"string" required:"true"` // The name of the delivery stream. // // DeliveryStreamName is a required field DeliveryStreamName *string `min:"1" type:"string" required:"true"` // The ID of the destination. // // DestinationId is a required field DestinationId *string `min:"1" type:"string" required:"true"` // Describes an update for a destination in Amazon ES. ElasticsearchDestinationUpdate *ElasticsearchDestinationUpdate `type:"structure"` // Describes an update for a destination in Amazon S3. ExtendedS3DestinationUpdate *ExtendedS3DestinationUpdate `type:"structure"` // Describes an update to the specified HTTP endpoint destination. HttpEndpointDestinationUpdate *HttpEndpointDestinationUpdate `type:"structure"` // Describes an update for a destination in Apache Iceberg Tables. // // Amazon Data Firehose is in preview release and is subject to change. IcebergDestinationUpdate *IcebergDestinationUpdate `type:"structure"` // Describes an update for a destination in Amazon Redshift. RedshiftDestinationUpdate *RedshiftDestinationUpdate `type:"structure"` // [Deprecated] Describes an update for a destination in Amazon S3. // // Deprecated: S3DestinationUpdate has been deprecated S3DestinationUpdate *S3DestinationUpdate `deprecated:"true" type:"structure"` // Update to the Snowflake destination configuration settings. SnowflakeDestinationUpdate *SnowflakeDestinationUpdate `type:"structure"` // Describes an update for a destination in Splunk. SplunkDestinationUpdate *SplunkDestinationUpdate `type:"structure"` // contains filtered or unexported fields }
func (s UpdateDestinationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateDestinationInput) SetAmazonOpenSearchServerlessDestinationUpdate(v *AmazonOpenSearchServerlessDestinationUpdate) *UpdateDestinationInput
SetAmazonOpenSearchServerlessDestinationUpdate sets the AmazonOpenSearchServerlessDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetAmazonopensearchserviceDestinationUpdate(v *AmazonopensearchserviceDestinationUpdate) *UpdateDestinationInput
SetAmazonopensearchserviceDestinationUpdate sets the AmazonopensearchserviceDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetCurrentDeliveryStreamVersionId(v string) *UpdateDestinationInput
SetCurrentDeliveryStreamVersionId sets the CurrentDeliveryStreamVersionId field's value.
func (s *UpdateDestinationInput) SetDeliveryStreamName(v string) *UpdateDestinationInput
SetDeliveryStreamName sets the DeliveryStreamName field's value.
func (s *UpdateDestinationInput) SetDestinationId(v string) *UpdateDestinationInput
SetDestinationId sets the DestinationId field's value.
func (s *UpdateDestinationInput) SetElasticsearchDestinationUpdate(v *ElasticsearchDestinationUpdate) *UpdateDestinationInput
SetElasticsearchDestinationUpdate sets the ElasticsearchDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetExtendedS3DestinationUpdate(v *ExtendedS3DestinationUpdate) *UpdateDestinationInput
SetExtendedS3DestinationUpdate sets the ExtendedS3DestinationUpdate field's value.
func (s *UpdateDestinationInput) SetHttpEndpointDestinationUpdate(v *HttpEndpointDestinationUpdate) *UpdateDestinationInput
SetHttpEndpointDestinationUpdate sets the HttpEndpointDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetIcebergDestinationUpdate(v *IcebergDestinationUpdate) *UpdateDestinationInput
SetIcebergDestinationUpdate sets the IcebergDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetRedshiftDestinationUpdate(v *RedshiftDestinationUpdate) *UpdateDestinationInput
SetRedshiftDestinationUpdate sets the RedshiftDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetS3DestinationUpdate(v *S3DestinationUpdate) *UpdateDestinationInput
SetS3DestinationUpdate sets the S3DestinationUpdate field's value.
func (s *UpdateDestinationInput) SetSnowflakeDestinationUpdate(v *SnowflakeDestinationUpdate) *UpdateDestinationInput
SetSnowflakeDestinationUpdate sets the SnowflakeDestinationUpdate field's value.
func (s *UpdateDestinationInput) SetSplunkDestinationUpdate(v *SplunkDestinationUpdate) *UpdateDestinationInput
SetSplunkDestinationUpdate sets the SplunkDestinationUpdate field's value.
func (s UpdateDestinationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateDestinationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDestinationOutput struct {
// contains filtered or unexported fields
}
func (s UpdateDestinationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateDestinationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type VpcConfiguration struct { // The ARN of the IAM role that you want the delivery stream to use to create // endpoints in the destination VPC. You can use your existing Firehose delivery // role or you can specify a new role. In either case, make sure that the role // trusts the Firehose service principal and that it grants the following permissions: // // * ec2:DescribeVpcs // // * ec2:DescribeVpcAttribute // // * ec2:DescribeSubnets // // * ec2:DescribeSecurityGroups // // * ec2:DescribeNetworkInterfaces // // * ec2:CreateNetworkInterface // // * ec2:CreateNetworkInterfacePermission // // * ec2:DeleteNetworkInterface // // When you specify subnets for delivering data to the destination in a private // VPC, make sure you have enough number of free IP addresses in chosen subnets. // If there is no available free IP address in a specified subnet, Firehose // cannot create or add ENIs for the data delivery in the private VPC, and the // delivery will be degraded or fail. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The IDs of the security groups that you want Firehose to use when it creates // ENIs in the VPC of the Amazon ES destination. You can use the same security // group that the Amazon ES domain uses or different ones. If you specify different // security groups here, ensure that they allow outbound HTTPS traffic to the // Amazon ES domain's security group. Also ensure that the Amazon ES domain's // security group allows HTTPS traffic from the security groups specified here. // If you use the same security group for both your delivery stream and the // Amazon ES domain, make sure the security group inbound rule allows HTTPS // traffic. For more information about security group rules, see Security group // rules (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) // in the Amazon VPC documentation. // // SecurityGroupIds is a required field SecurityGroupIds []*string `min:"1" type:"list" required:"true"` // The IDs of the subnets that you want Firehose to use to create ENIs in the // VPC of the Amazon ES destination. Make sure that the routing tables and inbound // and outbound rules allow traffic to flow from the subnets whose IDs are specified // here to the subnets that have the destination Amazon ES endpoints. Firehose // creates at least one ENI in each of the subnets that are specified here. // Do not delete or modify these ENIs. // // The number of ENIs that Firehose creates in the subnets specified here scales // up and down automatically based on throughput. To enable Firehose to scale // up the number of ENIs to match throughput, ensure that you have sufficient // quota. To help you calculate the quota you need, assume that Firehose can // create up to three ENIs for this delivery stream for each of the subnets // specified here. For more information about ENI quota, see Network Interfaces // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) // in the Amazon VPC Quotas topic. // // SubnetIds is a required field SubnetIds []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
func (s VpcConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *VpcConfiguration) SetRoleARN(v string) *VpcConfiguration
SetRoleARN sets the RoleARN field's value.
func (s *VpcConfiguration) SetSecurityGroupIds(v []*string) *VpcConfiguration
SetSecurityGroupIds sets the SecurityGroupIds field's value.
func (s *VpcConfiguration) SetSubnetIds(v []*string) *VpcConfiguration
SetSubnetIds sets the SubnetIds field's value.
func (s VpcConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *VpcConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VpcConfigurationDescription struct { // The ARN of the IAM role that the delivery stream uses to create endpoints // in the destination VPC. You can use your existing Firehose delivery role // or you can specify a new role. In either case, make sure that the role trusts // the Firehose service principal and that it grants the following permissions: // // * ec2:DescribeVpcs // // * ec2:DescribeVpcAttribute // // * ec2:DescribeSubnets // // * ec2:DescribeSecurityGroups // // * ec2:DescribeNetworkInterfaces // // * ec2:CreateNetworkInterface // // * ec2:CreateNetworkInterfacePermission // // * ec2:DeleteNetworkInterface // // If you revoke these permissions after you create the delivery stream, Firehose // can't scale out by creating more ENIs when necessary. You might therefore // see a degradation in performance. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // The IDs of the security groups that Firehose uses when it creates ENIs in // the VPC of the Amazon ES destination. You can use the same security group // that the Amazon ES domain uses or different ones. If you specify different // security groups, ensure that they allow outbound HTTPS traffic to the Amazon // ES domain's security group. Also ensure that the Amazon ES domain's security // group allows HTTPS traffic from the security groups specified here. If you // use the same security group for both your delivery stream and the Amazon // ES domain, make sure the security group inbound rule allows HTTPS traffic. // For more information about security group rules, see Security group rules // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) // in the Amazon VPC documentation. // // SecurityGroupIds is a required field SecurityGroupIds []*string `min:"1" type:"list" required:"true"` // The IDs of the subnets that Firehose uses to create ENIs in the VPC of the // Amazon ES destination. Make sure that the routing tables and inbound and // outbound rules allow traffic to flow from the subnets whose IDs are specified // here to the subnets that have the destination Amazon ES endpoints. Firehose // creates at least one ENI in each of the subnets that are specified here. // Do not delete or modify these ENIs. // // The number of ENIs that Firehose creates in the subnets specified here scales // up and down automatically based on throughput. To enable Firehose to scale // up the number of ENIs to match throughput, ensure that you have sufficient // quota. To help you calculate the quota you need, assume that Firehose can // create up to three ENIs for this delivery stream for each of the subnets // specified here. For more information about ENI quota, see Network Interfaces // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) // in the Amazon VPC Quotas topic. // // SubnetIds is a required field SubnetIds []*string `min:"1" type:"list" required:"true"` // The ID of the Amazon ES destination's VPC. // // VpcId is a required field VpcId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The details of the VPC of the Amazon ES destination.
func (s VpcConfigurationDescription) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *VpcConfigurationDescription) SetRoleARN(v string) *VpcConfigurationDescription
SetRoleARN sets the RoleARN field's value.
func (s *VpcConfigurationDescription) SetSecurityGroupIds(v []*string) *VpcConfigurationDescription
SetSecurityGroupIds sets the SecurityGroupIds field's value.
func (s *VpcConfigurationDescription) SetSubnetIds(v []*string) *VpcConfigurationDescription
SetSubnetIds sets the SubnetIds field's value.
func (s *VpcConfigurationDescription) SetVpcId(v string) *VpcConfigurationDescription
SetVpcId sets the VpcId field's value.
func (s VpcConfigurationDescription) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".