com.amazonaws.services.kinesisfirehose.model

Class CreateDeliveryStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDeliveryStreamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeliveryStreamRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeliveryStreamRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AmazonOpenSearchServerlessDestinationConfiguration	getAmazonOpenSearchServerlessDestinationConfiguration() The destination in the Serverless offering for Amazon OpenSearch Service.
AmazonopensearchserviceDestinationConfiguration	getAmazonopensearchserviceDestinationConfiguration() The destination in Amazon OpenSearch Service.
DeliveryStreamEncryptionConfigurationInput	getDeliveryStreamEncryptionConfigurationInput() Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
String	getDeliveryStreamName() The name of the delivery stream.
String	getDeliveryStreamType() The delivery stream type.
ElasticsearchDestinationConfiguration	getElasticsearchDestinationConfiguration() The destination in Amazon ES.
ExtendedS3DestinationConfiguration	getExtendedS3DestinationConfiguration() The destination in Amazon S3.
HttpEndpointDestinationConfiguration	getHttpEndpointDestinationConfiguration() Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
IcebergDestinationConfiguration	getIcebergDestinationConfiguration() Configure Apache Iceberg Tables destination.
KinesisStreamSourceConfiguration	getKinesisStreamSourceConfiguration() 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.
MSKSourceConfiguration	getMSKSourceConfiguration()
RedshiftDestinationConfiguration	getRedshiftDestinationConfiguration() The destination in Amazon Redshift.
S3DestinationConfiguration	getS3DestinationConfiguration() Deprecated.
SnowflakeDestinationConfiguration	getSnowflakeDestinationConfiguration() Configure Snowflake destination
SplunkDestinationConfiguration	getSplunkDestinationConfiguration() The destination in Splunk.
List<Tag>	getTags() A set of tags to assign to the delivery stream.
int	hashCode()
void	setAmazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration amazonOpenSearchServerlessDestinationConfiguration) The destination in the Serverless offering for Amazon OpenSearch Service.
void	setAmazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.
void	setDeliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput) Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
void	setDeliveryStreamName(String deliveryStreamName) The name of the delivery stream.
void	setDeliveryStreamType(String deliveryStreamType) The delivery stream type.
void	setElasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration) The destination in Amazon ES.
void	setExtendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration) The destination in Amazon S3.
void	setHttpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
void	setIcebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration) Configure Apache Iceberg Tables destination.
void	setKinesisStreamSourceConfiguration(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.
void	setMSKSourceConfiguration(MSKSourceConfiguration mSKSourceConfiguration)
void	setRedshiftDestinationConfiguration(RedshiftDestinationConfiguration redshiftDestinationConfiguration) The destination in Amazon Redshift.
void	setS3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration) Deprecated.
void	setSnowflakeDestinationConfiguration(SnowflakeDestinationConfiguration snowflakeDestinationConfiguration) Configure Snowflake destination
void	setSplunkDestinationConfiguration(SplunkDestinationConfiguration splunkDestinationConfiguration) The destination in Splunk.
void	setTags(Collection<Tag> tags) A set of tags to assign to the delivery stream.
String	toString() Returns a string representation of this object.
CreateDeliveryStreamRequest	withAmazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfiguration amazonOpenSearchServerlessDestinationConfiguration) The destination in the Serverless offering for Amazon OpenSearch Service.
CreateDeliveryStreamRequest	withAmazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfiguration amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.
CreateDeliveryStreamRequest	withDeliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput) Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
CreateDeliveryStreamRequest	withDeliveryStreamName(String deliveryStreamName) The name of the delivery stream.
CreateDeliveryStreamRequest	withDeliveryStreamType(DeliveryStreamType deliveryStreamType) The delivery stream type.
CreateDeliveryStreamRequest	withDeliveryStreamType(String deliveryStreamType) The delivery stream type.
CreateDeliveryStreamRequest	withElasticsearchDestinationConfiguration(ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration) The destination in Amazon ES.
CreateDeliveryStreamRequest	withExtendedS3DestinationConfiguration(ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration) The destination in Amazon S3.
CreateDeliveryStreamRequest	withHttpEndpointDestinationConfiguration(HttpEndpointDestinationConfiguration httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
CreateDeliveryStreamRequest	withIcebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration) Configure Apache Iceberg Tables destination.
CreateDeliveryStreamRequest	withKinesisStreamSourceConfiguration(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.
CreateDeliveryStreamRequest	withMSKSourceConfiguration(MSKSourceConfiguration mSKSourceConfiguration)
CreateDeliveryStreamRequest	withRedshiftDestinationConfiguration(RedshiftDestinationConfiguration redshiftDestinationConfiguration) The destination in Amazon Redshift.
CreateDeliveryStreamRequest	withS3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration) Deprecated.
CreateDeliveryStreamRequest	withSnowflakeDestinationConfiguration(SnowflakeDestinationConfiguration snowflakeDestinationConfiguration) Configure Snowflake destination
CreateDeliveryStreamRequest	withSplunkDestinationConfiguration(SplunkDestinationConfiguration splunkDestinationConfiguration) The destination in Splunk.
CreateDeliveryStreamRequest	withTags(Collection<Tag> tags) A set of tags to assign to the delivery stream.
CreateDeliveryStreamRequest	withTags(Tag... tags) A set of tags to assign to the delivery stream.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeliveryStreamRequest

public CreateDeliveryStreamRequest()

Method Detail

setDeliveryStreamName

public void setDeliveryStreamName(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.

getDeliveryStreamName

public String getDeliveryStreamName()

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:

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.

withDeliveryStreamName

public CreateDeliveryStreamRequest withDeliveryStreamName(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.

setDeliveryStreamType

public void setDeliveryStreamType(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.

See Also:

DeliveryStreamType

getDeliveryStreamType

public String getDeliveryStreamType()

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:

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.

See Also:

DeliveryStreamType

withDeliveryStreamType

public CreateDeliveryStreamRequest withDeliveryStreamType(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

withDeliveryStreamType

public CreateDeliveryStreamRequest withDeliveryStreamType(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

setKinesisStreamSourceConfiguration

public void setKinesisStreamSourceConfiguration(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.

getKinesisStreamSourceConfiguration

public KinesisStreamSourceConfiguration getKinesisStreamSourceConfiguration()

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:

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.

withKinesisStreamSourceConfiguration

public CreateDeliveryStreamRequest withKinesisStreamSourceConfiguration(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.

setDeliveryStreamEncryptionConfigurationInput

public void setDeliveryStreamEncryptionConfigurationInput(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).

getDeliveryStreamEncryptionConfigurationInput

public DeliveryStreamEncryptionConfigurationInput getDeliveryStreamEncryptionConfigurationInput()

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

Returns:

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

withDeliveryStreamEncryptionConfigurationInput

public CreateDeliveryStreamRequest withDeliveryStreamEncryptionConfigurationInput(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.

setS3DestinationConfiguration

@Deprecated
public void setS3DestinationConfiguration(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.

getS3DestinationConfiguration

@Deprecated
public S3DestinationConfiguration getS3DestinationConfiguration()

Deprecated.

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

Returns:

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

withS3DestinationConfiguration

@Deprecated
public CreateDeliveryStreamRequest withS3DestinationConfiguration(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.

setExtendedS3DestinationConfiguration

public void setExtendedS3DestinationConfiguration(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.

getExtendedS3DestinationConfiguration

public ExtendedS3DestinationConfiguration getExtendedS3DestinationConfiguration()

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

Returns:

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

withExtendedS3DestinationConfiguration

public CreateDeliveryStreamRequest withExtendedS3DestinationConfiguration(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.

setRedshiftDestinationConfiguration

public void setRedshiftDestinationConfiguration(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.

getRedshiftDestinationConfiguration

public RedshiftDestinationConfiguration getRedshiftDestinationConfiguration()

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

Returns:

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

withRedshiftDestinationConfiguration

public CreateDeliveryStreamRequest withRedshiftDestinationConfiguration(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.

setElasticsearchDestinationConfiguration

public void setElasticsearchDestinationConfiguration(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.

getElasticsearchDestinationConfiguration

public ElasticsearchDestinationConfiguration getElasticsearchDestinationConfiguration()

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

Returns:

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

withElasticsearchDestinationConfiguration

public CreateDeliveryStreamRequest withElasticsearchDestinationConfiguration(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.

setAmazonopensearchserviceDestinationConfiguration

public void setAmazonopensearchserviceDestinationConfiguration(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.

getAmazonopensearchserviceDestinationConfiguration

public AmazonopensearchserviceDestinationConfiguration getAmazonopensearchserviceDestinationConfiguration()

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

Returns:

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

withAmazonopensearchserviceDestinationConfiguration

public CreateDeliveryStreamRequest withAmazonopensearchserviceDestinationConfiguration(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.

setSplunkDestinationConfiguration

public void setSplunkDestinationConfiguration(SplunkDestinationConfiguration splunkDestinationConfiguration)

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

Parameters:

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

getSplunkDestinationConfiguration

public SplunkDestinationConfiguration getSplunkDestinationConfiguration()

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

Returns:

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

withSplunkDestinationConfiguration

public CreateDeliveryStreamRequest withSplunkDestinationConfiguration(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.

setHttpEndpointDestinationConfiguration

public void setHttpEndpointDestinationConfiguration(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.

getHttpEndpointDestinationConfiguration

public HttpEndpointDestinationConfiguration getHttpEndpointDestinationConfiguration()

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

Returns:

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

withHttpEndpointDestinationConfiguration

public CreateDeliveryStreamRequest withHttpEndpointDestinationConfiguration(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.

getTags

public List<Tag> getTags()

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:

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.

setTags

public void setTags(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.

withTags

public CreateDeliveryStreamRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateDeliveryStreamRequest withTags(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.

setAmazonOpenSearchServerlessDestinationConfiguration

public void setAmazonOpenSearchServerlessDestinationConfiguration(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.

getAmazonOpenSearchServerlessDestinationConfiguration

public AmazonOpenSearchServerlessDestinationConfiguration getAmazonOpenSearchServerlessDestinationConfiguration()

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

Returns:

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

withAmazonOpenSearchServerlessDestinationConfiguration

public CreateDeliveryStreamRequest withAmazonOpenSearchServerlessDestinationConfiguration(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.

setMSKSourceConfiguration

public void setMSKSourceConfiguration(MSKSourceConfiguration mSKSourceConfiguration)

Parameters:

mSKSourceConfiguration -

getMSKSourceConfiguration

public MSKSourceConfiguration getMSKSourceConfiguration()

Returns:

withMSKSourceConfiguration

public CreateDeliveryStreamRequest withMSKSourceConfiguration(MSKSourceConfiguration mSKSourceConfiguration)

Parameters:

mSKSourceConfiguration -

Returns:

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

setSnowflakeDestinationConfiguration

public void setSnowflakeDestinationConfiguration(SnowflakeDestinationConfiguration snowflakeDestinationConfiguration)

Configure Snowflake destination

Parameters:

snowflakeDestinationConfiguration - Configure Snowflake destination

getSnowflakeDestinationConfiguration

public SnowflakeDestinationConfiguration getSnowflakeDestinationConfiguration()

Configure Snowflake destination

Returns:

Configure Snowflake destination

withSnowflakeDestinationConfiguration

public CreateDeliveryStreamRequest withSnowflakeDestinationConfiguration(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.

setIcebergDestinationConfiguration

public void setIcebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration)

Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

Parameters:

icebergDestinationConfiguration - Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

getIcebergDestinationConfiguration

public IcebergDestinationConfiguration getIcebergDestinationConfiguration()

Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

Returns:

Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

withIcebergDestinationConfiguration

public CreateDeliveryStreamRequest withIcebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration)

Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

Parameters:

icebergDestinationConfiguration - Configure Apache Iceberg Tables destination.

Amazon Data Firehose is in preview release and is subject to change.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDeliveryStreamRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()