Package software.amazon.awssdk.services.firehose.model

Interface CreateDeliveryStreamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDeliveryStreamRequest.Builder,CreateDeliveryStreamRequest>, FirehoseRequest.Builder, SdkBuilder<CreateDeliveryStreamRequest.Builder,CreateDeliveryStreamRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDeliveryStreamRequest

public static interface CreateDeliveryStreamRequest.Builder
extends FirehoseRequest.Builder, SdkPojo, CopyableBuilder<CreateDeliveryStreamRequest.Builder,CreateDeliveryStreamRequest>

Method Summary

Modifier and Type	Method	Description
default CreateDeliveryStreamRequest.Builder	amazonOpenSearchServerlessDestinationConfiguration(Consumer<AmazonOpenSearchServerlessDestinationConfiguration.Builder> amazonOpenSearchServerlessDestinationConfiguration)	The destination in the Serverless offering for Amazon OpenSearch Service.
CreateDeliveryStreamRequest.Builder	amazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration amazonOpenSearchServerlessDestinationConfiguration)	The destination in the Serverless offering for Amazon OpenSearch Service.
default CreateDeliveryStreamRequest.Builder	amazonopensearchserviceDestinationConfiguration(Consumer<AmazonopensearchserviceDestinationConfiguration.Builder> amazonopensearchserviceDestinationConfiguration)	The destination in Amazon OpenSearch Service.
CreateDeliveryStreamRequest.Builder	amazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration amazonopensearchserviceDestinationConfiguration)	The destination in Amazon OpenSearch Service.
default CreateDeliveryStreamRequest.Builder	deliveryStreamEncryptionConfigurationInput(Consumer<DeliveryStreamEncryptionConfigurationInput.Builder> deliveryStreamEncryptionConfigurationInput)	Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
CreateDeliveryStreamRequest.Builder	deliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput)	Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
CreateDeliveryStreamRequest.Builder	deliveryStreamName(String deliveryStreamName)	The name of the delivery stream.
CreateDeliveryStreamRequest.Builder	deliveryStreamType(String deliveryStreamType)	The delivery stream type.
CreateDeliveryStreamRequest.Builder	deliveryStreamType(DeliveryStreamType deliveryStreamType)	The delivery stream type.
default CreateDeliveryStreamRequest.Builder	elasticsearchDestinationConfiguration(Consumer<ElasticsearchDestinationConfiguration.Builder> elasticsearchDestinationConfiguration)	The destination in Amazon ES.
CreateDeliveryStreamRequest.Builder	elasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration)	The destination in Amazon ES.
default CreateDeliveryStreamRequest.Builder	extendedS3DestinationConfiguration(Consumer<ExtendedS3DestinationConfiguration.Builder> extendedS3DestinationConfiguration)	The destination in Amazon S3.
CreateDeliveryStreamRequest.Builder	extendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration)	The destination in Amazon S3.
default CreateDeliveryStreamRequest.Builder	httpEndpointDestinationConfiguration(Consumer<HttpEndpointDestinationConfiguration.Builder> httpEndpointDestinationConfiguration)	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
CreateDeliveryStreamRequest.Builder	httpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration httpEndpointDestinationConfiguration)	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
default CreateDeliveryStreamRequest.Builder	kinesisStreamSourceConfiguration(Consumer<KinesisStreamSourceConfiguration.Builder> kinesisStreamSourceConfiguration)	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.
CreateDeliveryStreamRequest.Builder	kinesisStreamSourceConfiguration(KinesisStreamSourceConfiguration kinesisStreamSourceConfiguration)	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.
default CreateDeliveryStreamRequest.Builder	mskSourceConfiguration(Consumer<MSKSourceConfiguration.Builder> mskSourceConfiguration)	Sets the value of the MSKSourceConfiguration property for this object.
CreateDeliveryStreamRequest.Builder	mskSourceConfiguration(MSKSourceConfiguration mskSourceConfiguration)	Sets the value of the MSKSourceConfiguration property for this object.
CreateDeliveryStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDeliveryStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateDeliveryStreamRequest.Builder	redshiftDestinationConfiguration(Consumer<RedshiftDestinationConfiguration.Builder> redshiftDestinationConfiguration)	The destination in Amazon Redshift.
CreateDeliveryStreamRequest.Builder	redshiftDestinationConfiguration(RedshiftDestinationConfiguration redshiftDestinationConfiguration)	The destination in Amazon Redshift.
default CreateDeliveryStreamRequest.Builder	s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)	Deprecated.
CreateDeliveryStreamRequest.Builder	s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)	Deprecated.
default CreateDeliveryStreamRequest.Builder	snowflakeDestinationConfiguration(Consumer<SnowflakeDestinationConfiguration.Builder> snowflakeDestinationConfiguration)	Configure Snowflake destination
CreateDeliveryStreamRequest.Builder	snowflakeDestinationConfiguration(SnowflakeDestinationConfiguration snowflakeDestinationConfiguration)	Configure Snowflake destination
default CreateDeliveryStreamRequest.Builder	splunkDestinationConfiguration(Consumer<SplunkDestinationConfiguration.Builder> splunkDestinationConfiguration)	The destination in Splunk.
CreateDeliveryStreamRequest.Builder	splunkDestinationConfiguration(SplunkDestinationConfiguration splunkDestinationConfiguration)	The destination in Splunk.
CreateDeliveryStreamRequest.Builder	tags(Collection<Tag> tags)	A set of tags to assign to the delivery stream.
CreateDeliveryStreamRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A set of tags to assign to the delivery stream.
CreateDeliveryStreamRequest.Builder	tags(Tag... tags)	A set of tags to assign to the delivery stream.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.firehose.model.FirehoseRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

deliveryStreamName

CreateDeliveryStreamRequest.Builder deliveryStreamName(String deliveryStreamName)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

deliveryStreamType

CreateDeliveryStreamRequest.Builder deliveryStreamType(String deliveryStreamType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeliveryStreamType, DeliveryStreamType

deliveryStreamType

CreateDeliveryStreamRequest.Builder deliveryStreamType(DeliveryStreamType deliveryStreamType)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeliveryStreamType, DeliveryStreamType

kinesisStreamSourceConfiguration

CreateDeliveryStreamRequest.Builder kinesisStreamSourceConfiguration(KinesisStreamSourceConfiguration kinesisStreamSourceConfiguration)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisStreamSourceConfiguration

default CreateDeliveryStreamRequest.Builder kinesisStreamSourceConfiguration(Consumer<KinesisStreamSourceConfiguration.Builder> kinesisStreamSourceConfiguration)

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.

This is a convenience method that creates an instance of the KinesisStreamSourceConfiguration.Builder avoiding the need to create one manually via KinesisStreamSourceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisStreamSourceConfiguration(KinesisStreamSourceConfiguration).

Parameters:

kinesisStreamSourceConfiguration - a consumer that will call methods on KinesisStreamSourceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

kinesisStreamSourceConfiguration(KinesisStreamSourceConfiguration)

deliveryStreamEncryptionConfigurationInput

CreateDeliveryStreamRequest.Builder deliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput)

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Parameters:

deliveryStreamEncryptionConfigurationInput - Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Returns:

Returns a reference to this object so that method calls can be chained together.

deliveryStreamEncryptionConfigurationInput

default CreateDeliveryStreamRequest.Builder deliveryStreamEncryptionConfigurationInput(Consumer<DeliveryStreamEncryptionConfigurationInput.Builder> deliveryStreamEncryptionConfigurationInput)

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

This is a convenience method that creates an instance of the DeliveryStreamEncryptionConfigurationInput.Builder avoiding the need to create one manually via DeliveryStreamEncryptionConfigurationInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput).

Parameters:

deliveryStreamEncryptionConfigurationInput - a consumer that will call methods on DeliveryStreamEncryptionConfigurationInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

deliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput)

s3DestinationConfiguration

@Deprecated
CreateDeliveryStreamRequest.Builder s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)

Deprecated.

[Deprecated] The destination in Amazon S3. You can specify only one destination.

Parameters:

s3DestinationConfiguration - [Deprecated] The destination in Amazon S3. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3DestinationConfiguration

@Deprecated
default CreateDeliveryStreamRequest.Builder s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)

Deprecated.

[Deprecated] The destination in Amazon S3. You can specify only one destination.

This is a convenience method that creates an instance of the S3DestinationConfiguration.Builder avoiding the need to create one manually via S3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3DestinationConfiguration(S3DestinationConfiguration).

Parameters:

s3DestinationConfiguration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3DestinationConfiguration(S3DestinationConfiguration)

extendedS3DestinationConfiguration

CreateDeliveryStreamRequest.Builder extendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration)

The destination in Amazon S3. You can specify only one destination.

Parameters:

extendedS3DestinationConfiguration - The destination in Amazon S3. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

extendedS3DestinationConfiguration

default CreateDeliveryStreamRequest.Builder extendedS3DestinationConfiguration(Consumer<ExtendedS3DestinationConfiguration.Builder> extendedS3DestinationConfiguration)

The destination in Amazon S3. You can specify only one destination.

This is a convenience method that creates an instance of the ExtendedS3DestinationConfiguration.Builder avoiding the need to create one manually via ExtendedS3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to extendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration).

Parameters:

extendedS3DestinationConfiguration - a consumer that will call methods on ExtendedS3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

extendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration)

redshiftDestinationConfiguration

CreateDeliveryStreamRequest.Builder redshiftDestinationConfiguration(RedshiftDestinationConfiguration redshiftDestinationConfiguration)

The destination in Amazon Redshift. You can specify only one destination.

Parameters:

redshiftDestinationConfiguration - The destination in Amazon Redshift. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

redshiftDestinationConfiguration

default CreateDeliveryStreamRequest.Builder redshiftDestinationConfiguration(Consumer<RedshiftDestinationConfiguration.Builder> redshiftDestinationConfiguration)

The destination in Amazon Redshift. You can specify only one destination.

This is a convenience method that creates an instance of the RedshiftDestinationConfiguration.Builder avoiding the need to create one manually via RedshiftDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redshiftDestinationConfiguration(RedshiftDestinationConfiguration).

Parameters:

redshiftDestinationConfiguration - a consumer that will call methods on RedshiftDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

redshiftDestinationConfiguration(RedshiftDestinationConfiguration)

elasticsearchDestinationConfiguration

CreateDeliveryStreamRequest.Builder elasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration)

The destination in Amazon ES. You can specify only one destination.

Parameters:

elasticsearchDestinationConfiguration - The destination in Amazon ES. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

elasticsearchDestinationConfiguration

default CreateDeliveryStreamRequest.Builder elasticsearchDestinationConfiguration(Consumer<ElasticsearchDestinationConfiguration.Builder> elasticsearchDestinationConfiguration)

The destination in Amazon ES. You can specify only one destination.

This is a convenience method that creates an instance of the ElasticsearchDestinationConfiguration.Builder avoiding the need to create one manually via ElasticsearchDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration).

Parameters:

elasticsearchDestinationConfiguration - a consumer that will call methods on ElasticsearchDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

elasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration)

amazonopensearchserviceDestinationConfiguration

CreateDeliveryStreamRequest.Builder amazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration amazonopensearchserviceDestinationConfiguration)

The destination in Amazon OpenSearch Service. You can specify only one destination.

Parameters:

amazonopensearchserviceDestinationConfiguration - The destination in Amazon OpenSearch Service. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

amazonopensearchserviceDestinationConfiguration

default CreateDeliveryStreamRequest.Builder amazonopensearchserviceDestinationConfiguration(Consumer<AmazonopensearchserviceDestinationConfiguration.Builder> amazonopensearchserviceDestinationConfiguration)

The destination in Amazon OpenSearch Service. You can specify only one destination.

This is a convenience method that creates an instance of the AmazonopensearchserviceDestinationConfiguration.Builder avoiding the need to create one manually via AmazonopensearchserviceDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to amazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration).

Parameters:

amazonopensearchserviceDestinationConfiguration - a consumer that will call methods on AmazonopensearchserviceDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

amazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration)

splunkDestinationConfiguration

CreateDeliveryStreamRequest.Builder splunkDestinationConfiguration(SplunkDestinationConfiguration splunkDestinationConfiguration)

The destination in Splunk. You can specify only one destination.

Parameters:

splunkDestinationConfiguration - The destination in Splunk. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

splunkDestinationConfiguration

default CreateDeliveryStreamRequest.Builder splunkDestinationConfiguration(Consumer<SplunkDestinationConfiguration.Builder> splunkDestinationConfiguration)

The destination in Splunk. You can specify only one destination.

This is a convenience method that creates an instance of the SplunkDestinationConfiguration.Builder avoiding the need to create one manually via SplunkDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to splunkDestinationConfiguration(SplunkDestinationConfiguration).

Parameters:

splunkDestinationConfiguration - a consumer that will call methods on SplunkDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

splunkDestinationConfiguration(SplunkDestinationConfiguration)

httpEndpointDestinationConfiguration

CreateDeliveryStreamRequest.Builder httpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration httpEndpointDestinationConfiguration)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Parameters:

httpEndpointDestinationConfiguration - Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpEndpointDestinationConfiguration

default CreateDeliveryStreamRequest.Builder httpEndpointDestinationConfiguration(Consumer<HttpEndpointDestinationConfiguration.Builder> httpEndpointDestinationConfiguration)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

This is a convenience method that creates an instance of the HttpEndpointDestinationConfiguration.Builder avoiding the need to create one manually via HttpEndpointDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration).

Parameters:

httpEndpointDestinationConfiguration - a consumer that will call methods on HttpEndpointDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

httpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration)

tags

CreateDeliveryStreamRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDeliveryStreamRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDeliveryStreamRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

amazonOpenSearchServerlessDestinationConfiguration

CreateDeliveryStreamRequest.Builder amazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration amazonOpenSearchServerlessDestinationConfiguration)

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Parameters:

amazonOpenSearchServerlessDestinationConfiguration - The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

amazonOpenSearchServerlessDestinationConfiguration

default CreateDeliveryStreamRequest.Builder amazonOpenSearchServerlessDestinationConfiguration(Consumer<AmazonOpenSearchServerlessDestinationConfiguration.Builder> amazonOpenSearchServerlessDestinationConfiguration)

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

This is a convenience method that creates an instance of the AmazonOpenSearchServerlessDestinationConfiguration.Builder avoiding the need to create one manually via AmazonOpenSearchServerlessDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to amazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration).

Parameters:

amazonOpenSearchServerlessDestinationConfiguration - a consumer that will call methods on AmazonOpenSearchServerlessDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

amazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration)

mskSourceConfiguration

CreateDeliveryStreamRequest.Builder mskSourceConfiguration(MSKSourceConfiguration mskSourceConfiguration)

Sets the value of the MSKSourceConfiguration property for this object.

Parameters:

mskSourceConfiguration - The new value for the MSKSourceConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

mskSourceConfiguration

default CreateDeliveryStreamRequest.Builder mskSourceConfiguration(Consumer<MSKSourceConfiguration.Builder> mskSourceConfiguration)

Sets the value of the MSKSourceConfiguration property for this object. This is a convenience method that creates an instance of the MSKSourceConfiguration.Builder avoiding the need to create one manually via MSKSourceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mskSourceConfiguration(MSKSourceConfiguration).

Parameters:

mskSourceConfiguration - a consumer that will call methods on MSKSourceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

mskSourceConfiguration(MSKSourceConfiguration)

snowflakeDestinationConfiguration

CreateDeliveryStreamRequest.Builder snowflakeDestinationConfiguration(SnowflakeDestinationConfiguration snowflakeDestinationConfiguration)

Configure Snowflake destination

Parameters:

snowflakeDestinationConfiguration - Configure Snowflake destination

Returns:

Returns a reference to this object so that method calls can be chained together.

snowflakeDestinationConfiguration

default CreateDeliveryStreamRequest.Builder snowflakeDestinationConfiguration(Consumer<SnowflakeDestinationConfiguration.Builder> snowflakeDestinationConfiguration)

Configure Snowflake destination

This is a convenience method that creates an instance of the SnowflakeDestinationConfiguration.Builder avoiding the need to create one manually via SnowflakeDestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snowflakeDestinationConfiguration(SnowflakeDestinationConfiguration).

Parameters:

snowflakeDestinationConfiguration - a consumer that will call methods on SnowflakeDestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

snowflakeDestinationConfiguration(SnowflakeDestinationConfiguration)

overrideConfiguration

CreateDeliveryStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDeliveryStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder