firehose

package
v1.51.25 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2024 License: Apache-2.0 Imports: 10 Imported by: 369

Documentation

Overview

Package firehose provides the client and types for making API requests to Amazon Kinesis Firehose.

Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.

Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.

See https://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04 for more information on this service.

See firehose package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/firehose/

Using the Client

To contact Amazon Kinesis Firehose with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Kinesis Firehose client Firehose for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/firehose/#New

Index

Constants

View Source
const (
	// AmazonOpenSearchServerlessS3BackupModeFailedDocumentsOnly is a AmazonOpenSearchServerlessS3BackupMode enum value
	AmazonOpenSearchServerlessS3BackupModeFailedDocumentsOnly = "FailedDocumentsOnly"

	// AmazonOpenSearchServerlessS3BackupModeAllDocuments is a AmazonOpenSearchServerlessS3BackupMode enum value
	AmazonOpenSearchServerlessS3BackupModeAllDocuments = "AllDocuments"
)
View Source
const (
	// AmazonopensearchserviceIndexRotationPeriodNoRotation is a AmazonopensearchserviceIndexRotationPeriod enum value
	AmazonopensearchserviceIndexRotationPeriodNoRotation = "NoRotation"

	// AmazonopensearchserviceIndexRotationPeriodOneHour is a AmazonopensearchserviceIndexRotationPeriod enum value
	AmazonopensearchserviceIndexRotationPeriodOneHour = "OneHour"

	// AmazonopensearchserviceIndexRotationPeriodOneDay is a AmazonopensearchserviceIndexRotationPeriod enum value
	AmazonopensearchserviceIndexRotationPeriodOneDay = "OneDay"

	// AmazonopensearchserviceIndexRotationPeriodOneWeek is a AmazonopensearchserviceIndexRotationPeriod enum value
	AmazonopensearchserviceIndexRotationPeriodOneWeek = "OneWeek"

	// AmazonopensearchserviceIndexRotationPeriodOneMonth is a AmazonopensearchserviceIndexRotationPeriod enum value
	AmazonopensearchserviceIndexRotationPeriodOneMonth = "OneMonth"
)
View Source
const (
	// AmazonopensearchserviceS3BackupModeFailedDocumentsOnly is a AmazonopensearchserviceS3BackupMode enum value
	AmazonopensearchserviceS3BackupModeFailedDocumentsOnly = "FailedDocumentsOnly"

	// AmazonopensearchserviceS3BackupModeAllDocuments is a AmazonopensearchserviceS3BackupMode enum value
	AmazonopensearchserviceS3BackupModeAllDocuments = "AllDocuments"
)
View Source
const (
	// CompressionFormatUncompressed is a CompressionFormat enum value
	CompressionFormatUncompressed = "UNCOMPRESSED"

	// CompressionFormatGzip is a CompressionFormat enum value
	CompressionFormatGzip = "GZIP"

	// CompressionFormatZip is a CompressionFormat enum value
	CompressionFormatZip = "ZIP"

	// CompressionFormatSnappy is a CompressionFormat enum value
	CompressionFormatSnappy = "Snappy"

	// CompressionFormatHadoopSnappy is a CompressionFormat enum value
	CompressionFormatHadoopSnappy = "HADOOP_SNAPPY"
)
View Source
const (
	// ConnectivityPublic is a Connectivity enum value
	ConnectivityPublic = "PUBLIC"

	// ConnectivityPrivate is a Connectivity enum value
	ConnectivityPrivate = "PRIVATE"
)
View Source
const (
	// ContentEncodingNone is a ContentEncoding enum value
	ContentEncodingNone = "NONE"

	// ContentEncodingGzip is a ContentEncoding enum value
	ContentEncodingGzip = "GZIP"
)
View Source
const (
	// DefaultDocumentIdFormatFirehoseDefault is a DefaultDocumentIdFormat enum value
	DefaultDocumentIdFormatFirehoseDefault = "FIREHOSE_DEFAULT"

	// DefaultDocumentIdFormatNoDocumentId is a DefaultDocumentIdFormat enum value
	DefaultDocumentIdFormatNoDocumentId = "NO_DOCUMENT_ID"
)
View Source
const (
	// DeliveryStreamEncryptionStatusEnabled is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusEnabled = "ENABLED"

	// DeliveryStreamEncryptionStatusEnabling is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusEnabling = "ENABLING"

	// DeliveryStreamEncryptionStatusEnablingFailed is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusEnablingFailed = "ENABLING_FAILED"

	// DeliveryStreamEncryptionStatusDisabled is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusDisabled = "DISABLED"

	// DeliveryStreamEncryptionStatusDisabling is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusDisabling = "DISABLING"

	// DeliveryStreamEncryptionStatusDisablingFailed is a DeliveryStreamEncryptionStatus enum value
	DeliveryStreamEncryptionStatusDisablingFailed = "DISABLING_FAILED"
)
View Source
const (
	// DeliveryStreamFailureTypeRetireKmsGrantFailed is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeRetireKmsGrantFailed = "RETIRE_KMS_GRANT_FAILED"

	// DeliveryStreamFailureTypeCreateKmsGrantFailed is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeCreateKmsGrantFailed = "CREATE_KMS_GRANT_FAILED"

	// DeliveryStreamFailureTypeKmsAccessDenied is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeKmsAccessDenied = "KMS_ACCESS_DENIED"

	// DeliveryStreamFailureTypeDisabledKmsKey is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeDisabledKmsKey = "DISABLED_KMS_KEY"

	// DeliveryStreamFailureTypeInvalidKmsKey is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeInvalidKmsKey = "INVALID_KMS_KEY"

	// DeliveryStreamFailureTypeKmsKeyNotFound is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeKmsKeyNotFound = "KMS_KEY_NOT_FOUND"

	// DeliveryStreamFailureTypeKmsOptInRequired is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeKmsOptInRequired = "KMS_OPT_IN_REQUIRED"

	// DeliveryStreamFailureTypeCreateEniFailed is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeCreateEniFailed = "CREATE_ENI_FAILED"

	// DeliveryStreamFailureTypeDeleteEniFailed is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeDeleteEniFailed = "DELETE_ENI_FAILED"

	// DeliveryStreamFailureTypeSubnetNotFound is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeSubnetNotFound = "SUBNET_NOT_FOUND"

	// DeliveryStreamFailureTypeSecurityGroupNotFound is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeSecurityGroupNotFound = "SECURITY_GROUP_NOT_FOUND"

	// DeliveryStreamFailureTypeEniAccessDenied is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeEniAccessDenied = "ENI_ACCESS_DENIED"

	// DeliveryStreamFailureTypeSubnetAccessDenied is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeSubnetAccessDenied = "SUBNET_ACCESS_DENIED"

	// DeliveryStreamFailureTypeSecurityGroupAccessDenied is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeSecurityGroupAccessDenied = "SECURITY_GROUP_ACCESS_DENIED"

	// DeliveryStreamFailureTypeUnknownError is a DeliveryStreamFailureType enum value
	DeliveryStreamFailureTypeUnknownError = "UNKNOWN_ERROR"
)
View Source
const (
	// DeliveryStreamStatusCreating is a DeliveryStreamStatus enum value
	DeliveryStreamStatusCreating = "CREATING"

	// DeliveryStreamStatusCreatingFailed is a DeliveryStreamStatus enum value
	DeliveryStreamStatusCreatingFailed = "CREATING_FAILED"

	// DeliveryStreamStatusDeleting is a DeliveryStreamStatus enum value
	DeliveryStreamStatusDeleting = "DELETING"

	// DeliveryStreamStatusDeletingFailed is a DeliveryStreamStatus enum value
	DeliveryStreamStatusDeletingFailed = "DELETING_FAILED"

	// DeliveryStreamStatusActive is a DeliveryStreamStatus enum value
	DeliveryStreamStatusActive = "ACTIVE"
)
View Source
const (
	// DeliveryStreamTypeDirectPut is a DeliveryStreamType enum value
	DeliveryStreamTypeDirectPut = "DirectPut"

	// DeliveryStreamTypeKinesisStreamAsSource is a DeliveryStreamType enum value
	DeliveryStreamTypeKinesisStreamAsSource = "KinesisStreamAsSource"

	// DeliveryStreamTypeMskasSource is a DeliveryStreamType enum value
	DeliveryStreamTypeMskasSource = "MSKAsSource"
)
View Source
const (
	// ElasticsearchIndexRotationPeriodNoRotation is a ElasticsearchIndexRotationPeriod enum value
	ElasticsearchIndexRotationPeriodNoRotation = "NoRotation"

	// ElasticsearchIndexRotationPeriodOneHour is a ElasticsearchIndexRotationPeriod enum value
	ElasticsearchIndexRotationPeriodOneHour = "OneHour"

	// ElasticsearchIndexRotationPeriodOneDay is a ElasticsearchIndexRotationPeriod enum value
	ElasticsearchIndexRotationPeriodOneDay = "OneDay"

	// ElasticsearchIndexRotationPeriodOneWeek is a ElasticsearchIndexRotationPeriod enum value
	ElasticsearchIndexRotationPeriodOneWeek = "OneWeek"

	// ElasticsearchIndexRotationPeriodOneMonth is a ElasticsearchIndexRotationPeriod enum value
	ElasticsearchIndexRotationPeriodOneMonth = "OneMonth"
)
View Source
const (
	// ElasticsearchS3BackupModeFailedDocumentsOnly is a ElasticsearchS3BackupMode enum value
	ElasticsearchS3BackupModeFailedDocumentsOnly = "FailedDocumentsOnly"

	// ElasticsearchS3BackupModeAllDocuments is a ElasticsearchS3BackupMode enum value
	ElasticsearchS3BackupModeAllDocuments = "AllDocuments"
)
View Source
const (
	// HECEndpointTypeRaw is a HECEndpointType enum value
	HECEndpointTypeRaw = "Raw"

	// HECEndpointTypeEvent is a HECEndpointType enum value
	HECEndpointTypeEvent = "Event"
)
View Source
const (
	// HttpEndpointS3BackupModeFailedDataOnly is a HttpEndpointS3BackupMode enum value
	HttpEndpointS3BackupModeFailedDataOnly = "FailedDataOnly"

	// HttpEndpointS3BackupModeAllData is a HttpEndpointS3BackupMode enum value
	HttpEndpointS3BackupModeAllData = "AllData"
)
View Source
const (
	// KeyTypeAwsOwnedCmk is a KeyType enum value
	KeyTypeAwsOwnedCmk = "AWS_OWNED_CMK"

	// KeyTypeCustomerManagedCmk is a KeyType enum value
	KeyTypeCustomerManagedCmk = "CUSTOMER_MANAGED_CMK"
)
View Source
const (
	// OrcCompressionNone is a OrcCompression enum value
	OrcCompressionNone = "NONE"

	// OrcCompressionZlib is a OrcCompression enum value
	OrcCompressionZlib = "ZLIB"

	// OrcCompressionSnappy is a OrcCompression enum value
	OrcCompressionSnappy = "SNAPPY"
)
View Source
const (
	// OrcFormatVersionV011 is a OrcFormatVersion enum value
	OrcFormatVersionV011 = "V0_11"

	// OrcFormatVersionV012 is a OrcFormatVersion enum value
	OrcFormatVersionV012 = "V0_12"
)
View Source
const (
	// ParquetCompressionUncompressed is a ParquetCompression enum value
	ParquetCompressionUncompressed = "UNCOMPRESSED"

	// ParquetCompressionGzip is a ParquetCompression enum value
	ParquetCompressionGzip = "GZIP"

	// ParquetCompressionSnappy is a ParquetCompression enum value
	ParquetCompressionSnappy = "SNAPPY"
)
View Source
const (
	// ParquetWriterVersionV1 is a ParquetWriterVersion enum value
	ParquetWriterVersionV1 = "V1"

	// ParquetWriterVersionV2 is a ParquetWriterVersion enum value
	ParquetWriterVersionV2 = "V2"
)
View Source
const (
	// ProcessorParameterNameLambdaArn is a ProcessorParameterName enum value
	ProcessorParameterNameLambdaArn = "LambdaArn"

	// ProcessorParameterNameNumberOfRetries is a ProcessorParameterName enum value
	ProcessorParameterNameNumberOfRetries = "NumberOfRetries"

	// ProcessorParameterNameMetadataExtractionQuery is a ProcessorParameterName enum value
	ProcessorParameterNameMetadataExtractionQuery = "MetadataExtractionQuery"

	// ProcessorParameterNameJsonParsingEngine is a ProcessorParameterName enum value
	ProcessorParameterNameJsonParsingEngine = "JsonParsingEngine"

	// ProcessorParameterNameRoleArn is a ProcessorParameterName enum value
	ProcessorParameterNameRoleArn = "RoleArn"

	// ProcessorParameterNameBufferSizeInMbs is a ProcessorParameterName enum value
	ProcessorParameterNameBufferSizeInMbs = "BufferSizeInMBs"

	// ProcessorParameterNameBufferIntervalInSeconds is a ProcessorParameterName enum value
	ProcessorParameterNameBufferIntervalInSeconds = "BufferIntervalInSeconds"

	// ProcessorParameterNameSubRecordType is a ProcessorParameterName enum value
	ProcessorParameterNameSubRecordType = "SubRecordType"

	// ProcessorParameterNameDelimiter is a ProcessorParameterName enum value
	ProcessorParameterNameDelimiter = "Delimiter"

	// ProcessorParameterNameCompressionFormat is a ProcessorParameterName enum value
	ProcessorParameterNameCompressionFormat = "CompressionFormat"

	// ProcessorParameterNameDataMessageExtraction is a ProcessorParameterName enum value
	ProcessorParameterNameDataMessageExtraction = "DataMessageExtraction"
)
View Source
const (
	// ProcessorTypeRecordDeAggregation is a ProcessorType enum value
	ProcessorTypeRecordDeAggregation = "RecordDeAggregation"

	// ProcessorTypeDecompression is a ProcessorType enum value
	ProcessorTypeDecompression = "Decompression"

	// ProcessorTypeCloudWatchLogProcessing is a ProcessorType enum value
	ProcessorTypeCloudWatchLogProcessing = "CloudWatchLogProcessing"

	// ProcessorTypeLambda is a ProcessorType enum value
	ProcessorTypeLambda = "Lambda"

	// ProcessorTypeMetadataExtraction is a ProcessorType enum value
	ProcessorTypeMetadataExtraction = "MetadataExtraction"

	// ProcessorTypeAppendDelimiterToRecord is a ProcessorType enum value
	ProcessorTypeAppendDelimiterToRecord = "AppendDelimiterToRecord"
)
View Source
const (
	// RedshiftS3BackupModeDisabled is a RedshiftS3BackupMode enum value
	RedshiftS3BackupModeDisabled = "Disabled"

	// RedshiftS3BackupModeEnabled is a RedshiftS3BackupMode enum value
	RedshiftS3BackupModeEnabled = "Enabled"
)
View Source
const (
	// S3BackupModeDisabled is a S3BackupMode enum value
	S3BackupModeDisabled = "Disabled"

	// S3BackupModeEnabled is a S3BackupMode enum value
	S3BackupModeEnabled = "Enabled"
)
View Source
const (
	// SnowflakeDataLoadingOptionJsonMapping is a SnowflakeDataLoadingOption enum value
	SnowflakeDataLoadingOptionJsonMapping = "JSON_MAPPING"

	// SnowflakeDataLoadingOptionVariantContentMapping is a SnowflakeDataLoadingOption enum value
	SnowflakeDataLoadingOptionVariantContentMapping = "VARIANT_CONTENT_MAPPING"

	// SnowflakeDataLoadingOptionVariantContentAndMetadataMapping is a SnowflakeDataLoadingOption enum value
	SnowflakeDataLoadingOptionVariantContentAndMetadataMapping = "VARIANT_CONTENT_AND_METADATA_MAPPING"
)
View Source
const (
	// SnowflakeS3BackupModeFailedDataOnly is a SnowflakeS3BackupMode enum value
	SnowflakeS3BackupModeFailedDataOnly = "FailedDataOnly"

	// SnowflakeS3BackupModeAllData is a SnowflakeS3BackupMode enum value
	SnowflakeS3BackupModeAllData = "AllData"
)
View Source
const (
	// SplunkS3BackupModeFailedEventsOnly is a SplunkS3BackupMode enum value
	SplunkS3BackupModeFailedEventsOnly = "FailedEventsOnly"

	// SplunkS3BackupModeAllEvents is a SplunkS3BackupMode enum value
	SplunkS3BackupModeAllEvents = "AllEvents"
)
View Source
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Another modification has already happened. Fetch VersionId again and use
	// it to update the destination.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// The specified input parameter has a value that is not valid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidKMSResourceException for service response error code
	// "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.
	ErrCodeInvalidKMSResourceException = "InvalidKMSResourceException"

	// ErrCodeInvalidSourceException for service response error code
	// "InvalidSourceException".
	//
	// Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression
	// is enabled.
	ErrCodeInvalidSourceException = "InvalidSourceException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You have already reached the limit for a requested resource.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource is already in use and not available for this operation.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "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).
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
View Source
const (
	ServiceName = "firehose"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Firehose"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// NoEncryptionConfigNoEncryption is a NoEncryptionConfig enum value
	NoEncryptionConfigNoEncryption = "NoEncryption"
)

Variables

This section is empty.

Functions

func AmazonOpenSearchServerlessS3BackupMode_Values added in v1.44.148

func AmazonOpenSearchServerlessS3BackupMode_Values() []string

AmazonOpenSearchServerlessS3BackupMode_Values returns all elements of the AmazonOpenSearchServerlessS3BackupMode enum

func AmazonopensearchserviceIndexRotationPeriod_Values added in v1.40.58

func AmazonopensearchserviceIndexRotationPeriod_Values() []string

AmazonopensearchserviceIndexRotationPeriod_Values returns all elements of the AmazonopensearchserviceIndexRotationPeriod enum

func AmazonopensearchserviceS3BackupMode_Values added in v1.40.58

func AmazonopensearchserviceS3BackupMode_Values() []string

AmazonopensearchserviceS3BackupMode_Values returns all elements of the AmazonopensearchserviceS3BackupMode enum

func CompressionFormat_Values added in v1.34.3

func CompressionFormat_Values() []string

CompressionFormat_Values returns all elements of the CompressionFormat enum

func Connectivity_Values added in v1.45.18

func Connectivity_Values() []string

Connectivity_Values returns all elements of the Connectivity enum

func ContentEncoding_Values added in v1.34.3

func ContentEncoding_Values() []string

ContentEncoding_Values returns all elements of the ContentEncoding enum

func DefaultDocumentIdFormat_Values added in v1.45.9

func DefaultDocumentIdFormat_Values() []string

DefaultDocumentIdFormat_Values returns all elements of the DefaultDocumentIdFormat enum

func DeliveryStreamEncryptionStatus_Values added in v1.34.3

func DeliveryStreamEncryptionStatus_Values() []string

DeliveryStreamEncryptionStatus_Values returns all elements of the DeliveryStreamEncryptionStatus enum

func DeliveryStreamFailureType_Values added in v1.34.3

func DeliveryStreamFailureType_Values() []string

DeliveryStreamFailureType_Values returns all elements of the DeliveryStreamFailureType enum

func DeliveryStreamStatus_Values added in v1.34.3

func DeliveryStreamStatus_Values() []string

DeliveryStreamStatus_Values returns all elements of the DeliveryStreamStatus enum

func DeliveryStreamType_Values added in v1.34.3

func DeliveryStreamType_Values() []string

DeliveryStreamType_Values returns all elements of the DeliveryStreamType enum

func ElasticsearchIndexRotationPeriod_Values added in v1.34.3

func ElasticsearchIndexRotationPeriod_Values() []string

ElasticsearchIndexRotationPeriod_Values returns all elements of the ElasticsearchIndexRotationPeriod enum

func ElasticsearchS3BackupMode_Values added in v1.34.3

func ElasticsearchS3BackupMode_Values() []string

ElasticsearchS3BackupMode_Values returns all elements of the ElasticsearchS3BackupMode enum

func HECEndpointType_Values added in v1.34.3

func HECEndpointType_Values() []string

HECEndpointType_Values returns all elements of the HECEndpointType enum

func HttpEndpointS3BackupMode_Values added in v1.34.3

func HttpEndpointS3BackupMode_Values() []string

HttpEndpointS3BackupMode_Values returns all elements of the HttpEndpointS3BackupMode enum

func KeyType_Values added in v1.34.3

func KeyType_Values() []string

KeyType_Values returns all elements of the KeyType enum

func NoEncryptionConfig_Values added in v1.34.3

func NoEncryptionConfig_Values() []string

NoEncryptionConfig_Values returns all elements of the NoEncryptionConfig enum

func OrcCompression_Values added in v1.34.3

func OrcCompression_Values() []string

OrcCompression_Values returns all elements of the OrcCompression enum

func OrcFormatVersion_Values added in v1.34.3

func OrcFormatVersion_Values() []string

OrcFormatVersion_Values returns all elements of the OrcFormatVersion enum

func ParquetCompression_Values added in v1.34.3

func ParquetCompression_Values() []string

ParquetCompression_Values returns all elements of the ParquetCompression enum

func ParquetWriterVersion_Values added in v1.34.3

func ParquetWriterVersion_Values() []string

ParquetWriterVersion_Values returns all elements of the ParquetWriterVersion enum

func ProcessorParameterName_Values added in v1.34.3

func ProcessorParameterName_Values() []string

ProcessorParameterName_Values returns all elements of the ProcessorParameterName enum

func ProcessorType_Values added in v1.34.3

func ProcessorType_Values() []string

ProcessorType_Values returns all elements of the ProcessorType enum

func RedshiftS3BackupMode_Values added in v1.34.3

func RedshiftS3BackupMode_Values() []string

RedshiftS3BackupMode_Values returns all elements of the RedshiftS3BackupMode enum

func S3BackupMode_Values added in v1.34.3

func S3BackupMode_Values() []string

S3BackupMode_Values returns all elements of the S3BackupMode enum

func SnowflakeDataLoadingOption_Values added in v1.49.24

func SnowflakeDataLoadingOption_Values() []string

SnowflakeDataLoadingOption_Values returns all elements of the SnowflakeDataLoadingOption enum

func SnowflakeS3BackupMode_Values added in v1.49.24

func SnowflakeS3BackupMode_Values() []string

SnowflakeS3BackupMode_Values returns all elements of the SnowflakeS3BackupMode enum

func SplunkS3BackupMode_Values added in v1.34.3

func SplunkS3BackupMode_Values() []string

SplunkS3BackupMode_Values returns all elements of the SplunkS3BackupMode enum

Types

type AmazonOpenSearchServerlessBufferingHints added in v1.44.148

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 (AmazonOpenSearchServerlessBufferingHints) GoString added in v1.44.148

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 (*AmazonOpenSearchServerlessBufferingHints) SetIntervalInSeconds added in v1.44.148

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (*AmazonOpenSearchServerlessBufferingHints) SetSizeInMBs added in v1.44.148

SetSizeInMBs sets the SizeInMBs field's value.

func (AmazonOpenSearchServerlessBufferingHints) String added in v1.44.148

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 (*AmazonOpenSearchServerlessBufferingHints) Validate added in v1.44.148

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

type AmazonOpenSearchServerlessDestinationConfiguration added in v1.44.148

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 (AmazonOpenSearchServerlessDestinationConfiguration) GoString added in v1.44.148

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 (*AmazonOpenSearchServerlessDestinationConfiguration) SetBufferingHints added in v1.44.148

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetCloudWatchLoggingOptions added in v1.44.148

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetCollectionEndpoint added in v1.44.148

SetCollectionEndpoint sets the CollectionEndpoint field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetIndexName added in v1.44.148

SetIndexName sets the IndexName field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetProcessingConfiguration added in v1.44.148

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetRetryOptions added in v1.44.148

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetRoleARN added in v1.44.148

SetRoleARN sets the RoleARN field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetS3BackupMode added in v1.44.148

SetS3BackupMode sets the S3BackupMode field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetS3Configuration added in v1.44.148

SetS3Configuration sets the S3Configuration field's value.

func (*AmazonOpenSearchServerlessDestinationConfiguration) SetVpcConfiguration added in v1.44.148

SetVpcConfiguration sets the VpcConfiguration field's value.

func (AmazonOpenSearchServerlessDestinationConfiguration) String added in v1.44.148

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 (*AmazonOpenSearchServerlessDestinationConfiguration) Validate added in v1.44.148

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

type AmazonOpenSearchServerlessDestinationDescription added in v1.44.148

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 (AmazonOpenSearchServerlessDestinationDescription) GoString added in v1.44.148

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 (*AmazonOpenSearchServerlessDestinationDescription) SetBufferingHints added in v1.44.148

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetCloudWatchLoggingOptions added in v1.44.148

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetCollectionEndpoint added in v1.44.148

SetCollectionEndpoint sets the CollectionEndpoint field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetIndexName added in v1.44.148

SetIndexName sets the IndexName field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetProcessingConfiguration added in v1.44.148

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetRetryOptions added in v1.44.148

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetRoleARN added in v1.44.148

SetRoleARN sets the RoleARN field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetS3BackupMode added in v1.44.148

SetS3BackupMode sets the S3BackupMode field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetS3DestinationDescription added in v1.44.148

SetS3DestinationDescription sets the S3DestinationDescription field's value.

func (*AmazonOpenSearchServerlessDestinationDescription) SetVpcConfigurationDescription added in v1.44.148

SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.

func (AmazonOpenSearchServerlessDestinationDescription) String added in v1.44.148

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 added in v1.44.148

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 (AmazonOpenSearchServerlessDestinationUpdate) GoString added in v1.44.148

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 (*AmazonOpenSearchServerlessDestinationUpdate) SetBufferingHints added in v1.44.148

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetCloudWatchLoggingOptions added in v1.44.148

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetCollectionEndpoint added in v1.44.148

SetCollectionEndpoint sets the CollectionEndpoint field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetIndexName added in v1.44.148

SetIndexName sets the IndexName field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetProcessingConfiguration added in v1.44.148

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetRetryOptions added in v1.44.148

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetRoleARN added in v1.44.148

SetRoleARN sets the RoleARN field's value.

func (*AmazonOpenSearchServerlessDestinationUpdate) SetS3Update added in v1.44.148

SetS3Update sets the S3Update field's value.

func (AmazonOpenSearchServerlessDestinationUpdate) String added in v1.44.148

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 (*AmazonOpenSearchServerlessDestinationUpdate) Validate added in v1.44.148

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

type AmazonOpenSearchServerlessRetryOptions added in v1.44.148

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 (AmazonOpenSearchServerlessRetryOptions) GoString added in v1.44.148

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 (*AmazonOpenSearchServerlessRetryOptions) SetDurationInSeconds added in v1.44.148

SetDurationInSeconds sets the DurationInSeconds field's value.

func (AmazonOpenSearchServerlessRetryOptions) String added in v1.44.148

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 added in v1.40.58

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 (AmazonopensearchserviceBufferingHints) GoString added in v1.40.58

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 (*AmazonopensearchserviceBufferingHints) SetIntervalInSeconds added in v1.40.58

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (*AmazonopensearchserviceBufferingHints) SetSizeInMBs added in v1.40.58

SetSizeInMBs sets the SizeInMBs field's value.

func (AmazonopensearchserviceBufferingHints) String added in v1.40.58

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 (*AmazonopensearchserviceBufferingHints) Validate added in v1.40.58

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

type AmazonopensearchserviceDestinationConfiguration added in v1.40.58

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 (AmazonopensearchserviceDestinationConfiguration) GoString added in v1.40.58

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 (*AmazonopensearchserviceDestinationConfiguration) SetBufferingHints added in v1.40.58

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetCloudWatchLoggingOptions added in v1.40.58

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetClusterEndpoint added in v1.40.58

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetDomainARN added in v1.40.58

SetDomainARN sets the DomainARN field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetIndexName added in v1.40.58

SetIndexName sets the IndexName field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetIndexRotationPeriod added in v1.40.58

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetProcessingConfiguration added in v1.40.58

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetRetryOptions added in v1.40.58

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetRoleARN added in v1.40.58

SetRoleARN sets the RoleARN field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetS3BackupMode added in v1.40.58

SetS3BackupMode sets the S3BackupMode field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetS3Configuration added in v1.40.58

SetS3Configuration sets the S3Configuration field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetTypeName added in v1.40.58

SetTypeName sets the TypeName field's value.

func (*AmazonopensearchserviceDestinationConfiguration) SetVpcConfiguration added in v1.40.58

SetVpcConfiguration sets the VpcConfiguration field's value.

func (AmazonopensearchserviceDestinationConfiguration) String added in v1.40.58

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 (*AmazonopensearchserviceDestinationConfiguration) Validate added in v1.40.58

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

type AmazonopensearchserviceDestinationDescription added in v1.40.58

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 (AmazonopensearchserviceDestinationDescription) GoString added in v1.40.58

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 (*AmazonopensearchserviceDestinationDescription) SetBufferingHints added in v1.40.58

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonopensearchserviceDestinationDescription) SetCloudWatchLoggingOptions added in v1.40.58

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonopensearchserviceDestinationDescription) SetClusterEndpoint added in v1.40.58

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*AmazonopensearchserviceDestinationDescription) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*AmazonopensearchserviceDestinationDescription) SetDomainARN added in v1.40.58

SetDomainARN sets the DomainARN field's value.

func (*AmazonopensearchserviceDestinationDescription) SetIndexName added in v1.40.58

SetIndexName sets the IndexName field's value.

func (*AmazonopensearchserviceDestinationDescription) SetIndexRotationPeriod added in v1.40.58

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*AmazonopensearchserviceDestinationDescription) SetProcessingConfiguration added in v1.40.58

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonopensearchserviceDestinationDescription) SetRetryOptions added in v1.40.58

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonopensearchserviceDestinationDescription) SetRoleARN added in v1.40.58

SetRoleARN sets the RoleARN field's value.

func (*AmazonopensearchserviceDestinationDescription) SetS3BackupMode added in v1.40.58

SetS3BackupMode sets the S3BackupMode field's value.

func (*AmazonopensearchserviceDestinationDescription) SetS3DestinationDescription added in v1.40.58

SetS3DestinationDescription sets the S3DestinationDescription field's value.

func (*AmazonopensearchserviceDestinationDescription) SetTypeName added in v1.40.58

SetTypeName sets the TypeName field's value.

func (*AmazonopensearchserviceDestinationDescription) SetVpcConfigurationDescription added in v1.40.58

SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.

func (AmazonopensearchserviceDestinationDescription) String added in v1.40.58

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 added in v1.40.58

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 (AmazonopensearchserviceDestinationUpdate) GoString added in v1.40.58

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 (*AmazonopensearchserviceDestinationUpdate) SetBufferingHints added in v1.40.58

SetBufferingHints sets the BufferingHints field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetCloudWatchLoggingOptions added in v1.40.58

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetClusterEndpoint added in v1.40.58

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetDomainARN added in v1.40.58

SetDomainARN sets the DomainARN field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetIndexName added in v1.40.58

SetIndexName sets the IndexName field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetIndexRotationPeriod added in v1.40.58

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetProcessingConfiguration added in v1.40.58

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetRetryOptions added in v1.40.58

SetRetryOptions sets the RetryOptions field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetRoleARN added in v1.40.58

SetRoleARN sets the RoleARN field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetS3Update added in v1.40.58

SetS3Update sets the S3Update field's value.

func (*AmazonopensearchserviceDestinationUpdate) SetTypeName added in v1.40.58

SetTypeName sets the TypeName field's value.

func (AmazonopensearchserviceDestinationUpdate) String added in v1.40.58

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 (*AmazonopensearchserviceDestinationUpdate) Validate added in v1.40.58

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

type AmazonopensearchserviceRetryOptions added in v1.40.58

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 (AmazonopensearchserviceRetryOptions) GoString added in v1.40.58

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 (*AmazonopensearchserviceRetryOptions) SetDurationInSeconds added in v1.40.58

SetDurationInSeconds sets the DurationInSeconds field's value.

func (AmazonopensearchserviceRetryOptions) String added in v1.40.58

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 added in v1.45.18

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 (AuthenticationConfiguration) GoString added in v1.45.18

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 (*AuthenticationConfiguration) SetConnectivity added in v1.45.18

SetConnectivity sets the Connectivity field's value.

func (*AuthenticationConfiguration) SetRoleARN added in v1.45.18

SetRoleARN sets the RoleARN field's value.

func (AuthenticationConfiguration) String added in v1.45.18

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 (*AuthenticationConfiguration) Validate added in v1.45.18

func (s *AuthenticationConfiguration) Validate() error

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

type BufferingHints

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 (BufferingHints) GoString

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 (*BufferingHints) SetIntervalInSeconds added in v1.5.0

func (s *BufferingHints) SetIntervalInSeconds(v int64) *BufferingHints

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (*BufferingHints) SetSizeInMBs added in v1.5.0

func (s *BufferingHints) SetSizeInMBs(v int64) *BufferingHints

SetSizeInMBs sets the SizeInMBs field's value.

func (BufferingHints) String

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 (*BufferingHints) Validate added in v1.1.21

func (s *BufferingHints) Validate() error

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

type CloudWatchLoggingOptions added in v1.1.19

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 (CloudWatchLoggingOptions) GoString added in v1.1.19

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 (*CloudWatchLoggingOptions) SetEnabled added in v1.5.0

SetEnabled sets the Enabled field's value.

func (*CloudWatchLoggingOptions) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*CloudWatchLoggingOptions) SetLogStreamName added in v1.5.0

SetLogStreamName sets the LogStreamName field's value.

func (CloudWatchLoggingOptions) String added in v1.1.19

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 added in v1.28.0

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 (*ConcurrentModificationException) Code added in v1.28.0

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0

func (ConcurrentModificationException) GoString added in v1.28.0

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 (*ConcurrentModificationException) Message added in v1.28.0

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0

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

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 (CopyCommand) GoString

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 (*CopyCommand) SetCopyOptions added in v1.5.0

func (s *CopyCommand) SetCopyOptions(v string) *CopyCommand

SetCopyOptions sets the CopyOptions field's value.

func (*CopyCommand) SetDataTableColumns added in v1.5.0

func (s *CopyCommand) SetDataTableColumns(v string) *CopyCommand

SetDataTableColumns sets the DataTableColumns field's value.

func (*CopyCommand) SetDataTableName added in v1.5.0

func (s *CopyCommand) SetDataTableName(v string) *CopyCommand

SetDataTableName sets the DataTableName field's value.

func (CopyCommand) String

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 (*CopyCommand) Validate added in v1.1.21

func (s *CopyCommand) Validate() error

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

type CreateDeliveryStreamInput

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

	// 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 (CreateDeliveryStreamInput) GoString

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 (*CreateDeliveryStreamInput) SetAmazonOpenSearchServerlessDestinationConfiguration added in v1.44.148

func (s *CreateDeliveryStreamInput) SetAmazonOpenSearchServerlessDestinationConfiguration(v *AmazonOpenSearchServerlessDestinationConfiguration) *CreateDeliveryStreamInput

SetAmazonOpenSearchServerlessDestinationConfiguration sets the AmazonOpenSearchServerlessDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetAmazonopensearchserviceDestinationConfiguration added in v1.40.58

func (s *CreateDeliveryStreamInput) SetAmazonopensearchserviceDestinationConfiguration(v *AmazonopensearchserviceDestinationConfiguration) *CreateDeliveryStreamInput

SetAmazonopensearchserviceDestinationConfiguration sets the AmazonopensearchserviceDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetDeliveryStreamEncryptionConfigurationInput added in v1.25.39

func (s *CreateDeliveryStreamInput) SetDeliveryStreamEncryptionConfigurationInput(v *DeliveryStreamEncryptionConfigurationInput) *CreateDeliveryStreamInput

SetDeliveryStreamEncryptionConfigurationInput sets the DeliveryStreamEncryptionConfigurationInput field's value.

func (*CreateDeliveryStreamInput) SetDeliveryStreamName added in v1.5.0

func (s *CreateDeliveryStreamInput) SetDeliveryStreamName(v string) *CreateDeliveryStreamInput

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (*CreateDeliveryStreamInput) SetDeliveryStreamType added in v1.10.29

func (s *CreateDeliveryStreamInput) SetDeliveryStreamType(v string) *CreateDeliveryStreamInput

SetDeliveryStreamType sets the DeliveryStreamType field's value.

func (*CreateDeliveryStreamInput) SetElasticsearchDestinationConfiguration added in v1.5.0

func (s *CreateDeliveryStreamInput) SetElasticsearchDestinationConfiguration(v *ElasticsearchDestinationConfiguration) *CreateDeliveryStreamInput

SetElasticsearchDestinationConfiguration sets the ElasticsearchDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetExtendedS3DestinationConfiguration added in v1.6.6

func (s *CreateDeliveryStreamInput) SetExtendedS3DestinationConfiguration(v *ExtendedS3DestinationConfiguration) *CreateDeliveryStreamInput

SetExtendedS3DestinationConfiguration sets the ExtendedS3DestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetHttpEndpointDestinationConfiguration added in v1.33.15

func (s *CreateDeliveryStreamInput) SetHttpEndpointDestinationConfiguration(v *HttpEndpointDestinationConfiguration) *CreateDeliveryStreamInput

SetHttpEndpointDestinationConfiguration sets the HttpEndpointDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetKinesisStreamSourceConfiguration added in v1.10.29

func (s *CreateDeliveryStreamInput) SetKinesisStreamSourceConfiguration(v *KinesisStreamSourceConfiguration) *CreateDeliveryStreamInput

SetKinesisStreamSourceConfiguration sets the KinesisStreamSourceConfiguration field's value.

func (*CreateDeliveryStreamInput) SetMSKSourceConfiguration added in v1.45.18

SetMSKSourceConfiguration sets the MSKSourceConfiguration field's value.

func (*CreateDeliveryStreamInput) SetRedshiftDestinationConfiguration added in v1.5.0

func (s *CreateDeliveryStreamInput) SetRedshiftDestinationConfiguration(v *RedshiftDestinationConfiguration) *CreateDeliveryStreamInput

SetRedshiftDestinationConfiguration sets the RedshiftDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetS3DestinationConfiguration added in v1.5.0

SetS3DestinationConfiguration sets the S3DestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetSnowflakeDestinationConfiguration added in v1.49.24

func (s *CreateDeliveryStreamInput) SetSnowflakeDestinationConfiguration(v *SnowflakeDestinationConfiguration) *CreateDeliveryStreamInput

SetSnowflakeDestinationConfiguration sets the SnowflakeDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetSplunkDestinationConfiguration added in v1.12.31

SetSplunkDestinationConfiguration sets the SplunkDestinationConfiguration field's value.

func (*CreateDeliveryStreamInput) SetTags added in v1.15.74

SetTags sets the Tags field's value.

func (CreateDeliveryStreamInput) String

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 (*CreateDeliveryStreamInput) Validate added in v1.1.21

func (s *CreateDeliveryStreamInput) Validate() error

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

type CreateDeliveryStreamOutput

type CreateDeliveryStreamOutput struct {

	// The ARN of the delivery stream.
	DeliveryStreamARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDeliveryStreamOutput) GoString

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 (*CreateDeliveryStreamOutput) SetDeliveryStreamARN added in v1.5.0

func (s *CreateDeliveryStreamOutput) SetDeliveryStreamARN(v string) *CreateDeliveryStreamOutput

SetDeliveryStreamARN sets the DeliveryStreamARN field's value.

func (CreateDeliveryStreamOutput) 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 added in v1.13.47

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 (DataFormatConversionConfiguration) GoString added in v1.13.47

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 (*DataFormatConversionConfiguration) SetEnabled added in v1.13.47

SetEnabled sets the Enabled field's value.

func (*DataFormatConversionConfiguration) SetInputFormatConfiguration added in v1.13.47

SetInputFormatConfiguration sets the InputFormatConfiguration field's value.

func (*DataFormatConversionConfiguration) SetOutputFormatConfiguration added in v1.13.47

SetOutputFormatConfiguration sets the OutputFormatConfiguration field's value.

func (*DataFormatConversionConfiguration) SetSchemaConfiguration added in v1.13.47

SetSchemaConfiguration sets the SchemaConfiguration field's value.

func (DataFormatConversionConfiguration) String added in v1.13.47

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 (*DataFormatConversionConfiguration) Validate added in v1.13.47

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

type DeleteDeliveryStreamInput

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 (DeleteDeliveryStreamInput) GoString

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 (*DeleteDeliveryStreamInput) SetAllowForceDelete added in v1.25.39

func (s *DeleteDeliveryStreamInput) SetAllowForceDelete(v bool) *DeleteDeliveryStreamInput

SetAllowForceDelete sets the AllowForceDelete field's value.

func (*DeleteDeliveryStreamInput) SetDeliveryStreamName added in v1.5.0

func (s *DeleteDeliveryStreamInput) SetDeliveryStreamName(v string) *DeleteDeliveryStreamInput

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (DeleteDeliveryStreamInput) String

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 (*DeleteDeliveryStreamInput) Validate added in v1.1.21

func (s *DeleteDeliveryStreamInput) Validate() error

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

type DeleteDeliveryStreamOutput

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

func (DeleteDeliveryStreamOutput) GoString

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 (DeleteDeliveryStreamOutput) 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

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 (DeliveryStreamDescription) GoString

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 (*DeliveryStreamDescription) SetCreateTimestamp added in v1.5.0

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*DeliveryStreamDescription) SetDeliveryStreamARN added in v1.5.0

func (s *DeliveryStreamDescription) SetDeliveryStreamARN(v string) *DeliveryStreamDescription

SetDeliveryStreamARN sets the DeliveryStreamARN field's value.

func (*DeliveryStreamDescription) SetDeliveryStreamEncryptionConfiguration added in v1.15.74

func (s *DeliveryStreamDescription) SetDeliveryStreamEncryptionConfiguration(v *DeliveryStreamEncryptionConfiguration) *DeliveryStreamDescription

SetDeliveryStreamEncryptionConfiguration sets the DeliveryStreamEncryptionConfiguration field's value.

func (*DeliveryStreamDescription) SetDeliveryStreamName added in v1.5.0

func (s *DeliveryStreamDescription) SetDeliveryStreamName(v string) *DeliveryStreamDescription

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (*DeliveryStreamDescription) SetDeliveryStreamStatus added in v1.5.0

func (s *DeliveryStreamDescription) SetDeliveryStreamStatus(v string) *DeliveryStreamDescription

SetDeliveryStreamStatus sets the DeliveryStreamStatus field's value.

func (*DeliveryStreamDescription) SetDeliveryStreamType added in v1.10.29

func (s *DeliveryStreamDescription) SetDeliveryStreamType(v string) *DeliveryStreamDescription

SetDeliveryStreamType sets the DeliveryStreamType field's value.

func (*DeliveryStreamDescription) SetDestinations added in v1.5.0

SetDestinations sets the Destinations field's value.

func (*DeliveryStreamDescription) SetFailureDescription added in v1.25.39

SetFailureDescription sets the FailureDescription field's value.

func (*DeliveryStreamDescription) SetHasMoreDestinations added in v1.5.0

func (s *DeliveryStreamDescription) SetHasMoreDestinations(v bool) *DeliveryStreamDescription

SetHasMoreDestinations sets the HasMoreDestinations field's value.

func (*DeliveryStreamDescription) SetLastUpdateTimestamp added in v1.5.0

func (s *DeliveryStreamDescription) SetLastUpdateTimestamp(v time.Time) *DeliveryStreamDescription

SetLastUpdateTimestamp sets the LastUpdateTimestamp field's value.

func (*DeliveryStreamDescription) SetSource added in v1.10.29

SetSource sets the Source field's value.

func (*DeliveryStreamDescription) SetVersionId added in v1.5.0

SetVersionId sets the VersionId field's value.

func (DeliveryStreamDescription) String

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 added in v1.15.74

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 (DeliveryStreamEncryptionConfiguration) GoString added in v1.15.74

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 (*DeliveryStreamEncryptionConfiguration) SetFailureDescription added in v1.25.39

SetFailureDescription sets the FailureDescription field's value.

func (*DeliveryStreamEncryptionConfiguration) SetKeyARN added in v1.25.39

SetKeyARN sets the KeyARN field's value.

func (*DeliveryStreamEncryptionConfiguration) SetKeyType added in v1.25.39

SetKeyType sets the KeyType field's value.

func (*DeliveryStreamEncryptionConfiguration) SetStatus added in v1.15.74

SetStatus sets the Status field's value.

func (DeliveryStreamEncryptionConfiguration) String added in v1.15.74

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 added in v1.25.39

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 (DeliveryStreamEncryptionConfigurationInput) GoString added in v1.25.39

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 (*DeliveryStreamEncryptionConfigurationInput) SetKeyARN added in v1.25.39

SetKeyARN sets the KeyARN field's value.

func (*DeliveryStreamEncryptionConfigurationInput) SetKeyType added in v1.25.39

SetKeyType sets the KeyType field's value.

func (DeliveryStreamEncryptionConfigurationInput) String added in v1.25.39

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 (*DeliveryStreamEncryptionConfigurationInput) Validate added in v1.25.39

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

type DescribeDeliveryStreamInput

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 (DescribeDeliveryStreamInput) GoString

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 (*DescribeDeliveryStreamInput) SetDeliveryStreamName added in v1.5.0

func (s *DescribeDeliveryStreamInput) SetDeliveryStreamName(v string) *DescribeDeliveryStreamInput

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (*DescribeDeliveryStreamInput) SetExclusiveStartDestinationId added in v1.5.0

func (s *DescribeDeliveryStreamInput) SetExclusiveStartDestinationId(v string) *DescribeDeliveryStreamInput

SetExclusiveStartDestinationId sets the ExclusiveStartDestinationId field's value.

func (*DescribeDeliveryStreamInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (DescribeDeliveryStreamInput) 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 (*DescribeDeliveryStreamInput) Validate added in v1.1.21

func (s *DescribeDeliveryStreamInput) Validate() error

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

type DescribeDeliveryStreamOutput

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 (DescribeDeliveryStreamOutput) GoString

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 (*DescribeDeliveryStreamOutput) SetDeliveryStreamDescription added in v1.5.0

SetDeliveryStreamDescription sets the DeliveryStreamDescription field's value.

func (DescribeDeliveryStreamOutput) 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 added in v1.13.47

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 (Deserializer) GoString added in v1.13.47

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 (*Deserializer) SetHiveJsonSerDe added in v1.13.47

func (s *Deserializer) SetHiveJsonSerDe(v *HiveJsonSerDe) *Deserializer

SetHiveJsonSerDe sets the HiveJsonSerDe field's value.

func (*Deserializer) SetOpenXJsonSerDe added in v1.13.47

func (s *Deserializer) SetOpenXJsonSerDe(v *OpenXJsonSerDe) *Deserializer

SetOpenXJsonSerDe sets the OpenXJsonSerDe field's value.

func (Deserializer) String added in v1.13.47

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

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

	// 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 (DestinationDescription) GoString

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 (*DestinationDescription) SetAmazonOpenSearchServerlessDestinationDescription added in v1.44.148

func (s *DestinationDescription) SetAmazonOpenSearchServerlessDestinationDescription(v *AmazonOpenSearchServerlessDestinationDescription) *DestinationDescription

SetAmazonOpenSearchServerlessDestinationDescription sets the AmazonOpenSearchServerlessDestinationDescription field's value.

func (*DestinationDescription) SetAmazonopensearchserviceDestinationDescription added in v1.40.58

func (s *DestinationDescription) SetAmazonopensearchserviceDestinationDescription(v *AmazonopensearchserviceDestinationDescription) *DestinationDescription

SetAmazonopensearchserviceDestinationDescription sets the AmazonopensearchserviceDestinationDescription field's value.

func (*DestinationDescription) SetDestinationId added in v1.5.0

func (s *DestinationDescription) SetDestinationId(v string) *DestinationDescription

SetDestinationId sets the DestinationId field's value.

func (*DestinationDescription) SetElasticsearchDestinationDescription added in v1.5.0

func (s *DestinationDescription) SetElasticsearchDestinationDescription(v *ElasticsearchDestinationDescription) *DestinationDescription

SetElasticsearchDestinationDescription sets the ElasticsearchDestinationDescription field's value.

func (*DestinationDescription) SetExtendedS3DestinationDescription added in v1.6.6

func (s *DestinationDescription) SetExtendedS3DestinationDescription(v *ExtendedS3DestinationDescription) *DestinationDescription

SetExtendedS3DestinationDescription sets the ExtendedS3DestinationDescription field's value.

func (*DestinationDescription) SetHttpEndpointDestinationDescription added in v1.33.15

func (s *DestinationDescription) SetHttpEndpointDestinationDescription(v *HttpEndpointDestinationDescription) *DestinationDescription

SetHttpEndpointDestinationDescription sets the HttpEndpointDestinationDescription field's value.

func (*DestinationDescription) SetRedshiftDestinationDescription added in v1.5.0

func (s *DestinationDescription) SetRedshiftDestinationDescription(v *RedshiftDestinationDescription) *DestinationDescription

SetRedshiftDestinationDescription sets the RedshiftDestinationDescription field's value.

func (*DestinationDescription) SetS3DestinationDescription added in v1.5.0

func (s *DestinationDescription) SetS3DestinationDescription(v *S3DestinationDescription) *DestinationDescription

SetS3DestinationDescription sets the S3DestinationDescription field's value.

func (*DestinationDescription) SetSnowflakeDestinationDescription added in v1.49.24

func (s *DestinationDescription) SetSnowflakeDestinationDescription(v *SnowflakeDestinationDescription) *DestinationDescription

SetSnowflakeDestinationDescription sets the SnowflakeDestinationDescription field's value.

func (*DestinationDescription) SetSplunkDestinationDescription added in v1.12.31

func (s *DestinationDescription) SetSplunkDestinationDescription(v *SplunkDestinationDescription) *DestinationDescription

SetSplunkDestinationDescription sets the SplunkDestinationDescription field's value.

func (DestinationDescription) String

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 DocumentIdOptions added in v1.45.9

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 (DocumentIdOptions) GoString added in v1.45.9

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 (*DocumentIdOptions) SetDefaultDocumentIdFormat added in v1.45.9

func (s *DocumentIdOptions) SetDefaultDocumentIdFormat(v string) *DocumentIdOptions

SetDefaultDocumentIdFormat sets the DefaultDocumentIdFormat field's value.

func (DocumentIdOptions) String added in v1.45.9

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 (*DocumentIdOptions) Validate added in v1.45.9

func (s *DocumentIdOptions) Validate() error

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

type DynamicPartitioningConfiguration added in v1.40.33

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 (DynamicPartitioningConfiguration) GoString added in v1.40.33

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 (*DynamicPartitioningConfiguration) SetEnabled added in v1.40.33

SetEnabled sets the Enabled field's value.

func (*DynamicPartitioningConfiguration) SetRetryOptions added in v1.40.33

SetRetryOptions sets the RetryOptions field's value.

func (DynamicPartitioningConfiguration) String added in v1.40.33

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 added in v1.1.19

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 (ElasticsearchBufferingHints) GoString added in v1.1.19

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 (*ElasticsearchBufferingHints) SetIntervalInSeconds added in v1.5.0

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (*ElasticsearchBufferingHints) SetSizeInMBs added in v1.5.0

SetSizeInMBs sets the SizeInMBs field's value.

func (ElasticsearchBufferingHints) String added in v1.1.19

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 (*ElasticsearchBufferingHints) Validate added in v1.1.21

func (s *ElasticsearchBufferingHints) Validate() error

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

type ElasticsearchDestinationConfiguration added in v1.1.19

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 (ElasticsearchDestinationConfiguration) GoString added in v1.1.19

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 (*ElasticsearchDestinationConfiguration) SetBufferingHints added in v1.5.0

SetBufferingHints sets the BufferingHints field's value.

func (*ElasticsearchDestinationConfiguration) SetCloudWatchLoggingOptions added in v1.5.0

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*ElasticsearchDestinationConfiguration) SetClusterEndpoint added in v1.25.7

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*ElasticsearchDestinationConfiguration) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*ElasticsearchDestinationConfiguration) SetDomainARN added in v1.5.0

SetDomainARN sets the DomainARN field's value.

func (*ElasticsearchDestinationConfiguration) SetIndexName added in v1.5.0

SetIndexName sets the IndexName field's value.

func (*ElasticsearchDestinationConfiguration) SetIndexRotationPeriod added in v1.5.0

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*ElasticsearchDestinationConfiguration) SetProcessingConfiguration added in v1.6.6

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*ElasticsearchDestinationConfiguration) SetRetryOptions added in v1.5.0

SetRetryOptions sets the RetryOptions field's value.

func (*ElasticsearchDestinationConfiguration) SetRoleARN added in v1.5.0

SetRoleARN sets the RoleARN field's value.

func (*ElasticsearchDestinationConfiguration) SetS3BackupMode added in v1.5.0

SetS3BackupMode sets the S3BackupMode field's value.

func (*ElasticsearchDestinationConfiguration) SetS3Configuration added in v1.5.0

SetS3Configuration sets the S3Configuration field's value.

func (*ElasticsearchDestinationConfiguration) SetTypeName added in v1.5.0

SetTypeName sets the TypeName field's value.

func (*ElasticsearchDestinationConfiguration) SetVpcConfiguration added in v1.30.13

SetVpcConfiguration sets the VpcConfiguration field's value.

func (ElasticsearchDestinationConfiguration) String added in v1.1.19

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 (*ElasticsearchDestinationConfiguration) Validate added in v1.1.21

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

type ElasticsearchDestinationDescription added in v1.1.19

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 (ElasticsearchDestinationDescription) GoString added in v1.1.19

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 (*ElasticsearchDestinationDescription) SetBufferingHints added in v1.5.0

SetBufferingHints sets the BufferingHints field's value.

func (*ElasticsearchDestinationDescription) SetCloudWatchLoggingOptions added in v1.5.0

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*ElasticsearchDestinationDescription) SetClusterEndpoint added in v1.25.7

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*ElasticsearchDestinationDescription) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*ElasticsearchDestinationDescription) SetDomainARN added in v1.5.0

SetDomainARN sets the DomainARN field's value.

func (*ElasticsearchDestinationDescription) SetIndexName added in v1.5.0

SetIndexName sets the IndexName field's value.

func (*ElasticsearchDestinationDescription) SetIndexRotationPeriod added in v1.5.0

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*ElasticsearchDestinationDescription) SetProcessingConfiguration added in v1.6.6

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*ElasticsearchDestinationDescription) SetRetryOptions added in v1.5.0

SetRetryOptions sets the RetryOptions field's value.

func (*ElasticsearchDestinationDescription) SetRoleARN added in v1.5.0

SetRoleARN sets the RoleARN field's value.

func (*ElasticsearchDestinationDescription) SetS3BackupMode added in v1.5.0

SetS3BackupMode sets the S3BackupMode field's value.

func (*ElasticsearchDestinationDescription) SetS3DestinationDescription added in v1.5.0

SetS3DestinationDescription sets the S3DestinationDescription field's value.

func (*ElasticsearchDestinationDescription) SetTypeName added in v1.5.0

SetTypeName sets the TypeName field's value.

func (*ElasticsearchDestinationDescription) SetVpcConfigurationDescription added in v1.30.13

SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value.

func (ElasticsearchDestinationDescription) String added in v1.1.19

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 added in v1.1.19

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 (ElasticsearchDestinationUpdate) GoString added in v1.1.19

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 (*ElasticsearchDestinationUpdate) SetBufferingHints added in v1.5.0

SetBufferingHints sets the BufferingHints field's value.

func (*ElasticsearchDestinationUpdate) SetCloudWatchLoggingOptions added in v1.5.0

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

func (*ElasticsearchDestinationUpdate) SetClusterEndpoint added in v1.25.7

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*ElasticsearchDestinationUpdate) SetDocumentIdOptions added in v1.45.9

SetDocumentIdOptions sets the DocumentIdOptions field's value.

func (*ElasticsearchDestinationUpdate) SetDomainARN added in v1.5.0

SetDomainARN sets the DomainARN field's value.

func (*ElasticsearchDestinationUpdate) SetIndexName added in v1.5.0

SetIndexName sets the IndexName field's value.

func (*ElasticsearchDestinationUpdate) SetIndexRotationPeriod added in v1.5.0

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

func (*ElasticsearchDestinationUpdate) SetProcessingConfiguration added in v1.6.6

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

func (*ElasticsearchDestinationUpdate) SetRetryOptions added in v1.5.0

SetRetryOptions sets the RetryOptions field's value.

func (*ElasticsearchDestinationUpdate) SetRoleARN added in v1.5.0

SetRoleARN sets the RoleARN field's value.

func (*ElasticsearchDestinationUpdate) SetS3Update added in v1.5.0

SetS3Update sets the S3Update field's value.

func (*ElasticsearchDestinationUpdate) SetTypeName added in v1.5.0

SetTypeName sets the TypeName field's value.

func (ElasticsearchDestinationUpdate) String added in v1.1.19

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 (*ElasticsearchDestinationUpdate) Validate added in v1.1.21

func (s *ElasticsearchDestinationUpdate) Validate() error

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

type ElasticsearchRetryOptions added in v1.1.19

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 (ElasticsearchRetryOptions) GoString added in v1.1.19

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 (*ElasticsearchRetryOptions) SetDurationInSeconds added in v1.5.0

func (s *ElasticsearchRetryOptions) SetDurationInSeconds(v int64) *ElasticsearchRetryOptions

SetDurationInSeconds sets the DurationInSeconds field's value.

func (ElasticsearchRetryOptions) String added in v1.1.19

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

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 (EncryptionConfiguration) GoString

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 (*EncryptionConfiguration) SetKMSEncryptionConfig added in v1.5.0

SetKMSEncryptionConfig sets the KMSEncryptionConfig field's value.

func (*EncryptionConfiguration) SetNoEncryptionConfig added in v1.5.0

func (s *EncryptionConfiguration) SetNoEncryptionConfig(v string) *EncryptionConfiguration

SetNoEncryptionConfig sets the NoEncryptionConfig field's value.

func (EncryptionConfiguration) String

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 (*EncryptionConfiguration) Validate added in v1.1.21

func (s *EncryptionConfiguration) Validate() error

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

type ExtendedS3DestinationConfiguration added in v1.6.6

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 f