Package software.amazon.awscdk.services.kinesis

Class CfnChannel.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.CfnChannel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannel>

Enclosing class:

CfnChannel

@Stability(Stable)
public static final class CfnChannel.Builder
extends Object
implements software.amazon.jsii.Builder<CfnChannel>

A fluent builder for CfnChannel.

Method Summary

Modifier and Type	Method	Description
CfnChannel	build()
CfnChannel.Builder	channelName(String channelName)	The name of the channel.
static CfnChannel.Builder	create(software.constructs.Construct scope, String id)
CfnChannel.Builder	encryptionConfiguration(IResolvable encryptionConfiguration)	Server-side encryption configuration for data at rest in the destination.
CfnChannel.Builder	encryptionConfiguration(CfnChannel.EncryptionConfigurationProperty encryptionConfiguration)	Server-side encryption configuration for data at rest in the destination.
CfnChannel.Builder	loggingConfiguration(IResolvable loggingConfiguration)	Configuration for delivering channel operational logs.
CfnChannel.Builder	loggingConfiguration(CfnChannel.LoggingConfigurationProperty loggingConfiguration)	Configuration for delivering channel operational logs.
CfnChannel.Builder	s3DestinationConfiguration(IResolvable s3DestinationConfiguration)	Configuration for delivery to a vanilla S3 bucket destination.
CfnChannel.Builder	s3DestinationConfiguration(CfnChannel.S3DestinationConfigurationProperty s3DestinationConfiguration)	Configuration for delivery to a vanilla S3 bucket destination.
CfnChannel.Builder	s3TablesDestinationConfiguration(IResolvable s3TablesDestinationConfiguration)	Configuration for delivery to S3 Tables destinations.
CfnChannel.Builder	s3TablesDestinationConfiguration(CfnChannel.S3TablesDestinationConfigurationProperty s3TablesDestinationConfiguration)	Configuration for delivery to S3 Tables destinations.
CfnChannel.Builder	serviceExecutionRoleArn(String serviceExecutionRoleArn)	The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.
CfnChannel.Builder	streamConfigurationList(List<? extends Object> streamConfigurationList)	List of stream configurations associated with the channel.
CfnChannel.Builder	streamConfigurationList(IResolvable streamConfigurationList)	List of stream configurations associated with the channel.
CfnChannel.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnChannel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnChannel.Builder.

channelName

@Stability(Stable)
public CfnChannel.Builder channelName(String channelName)

The name of the channel.

The name's uniqueness is scoped per AWS account and region.

Parameters:

channelName - The name of the channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-channelname

serviceExecutionRoleArn

@Stability(Stable)
public CfnChannel.Builder serviceExecutionRoleArn(String serviceExecutionRoleArn)

The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.

Parameters:

serviceExecutionRoleArn - The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-serviceexecutionrolearn

streamConfigurationList

@Stability(Stable)
public CfnChannel.Builder streamConfigurationList(IResolvable streamConfigurationList)

List of stream configurations associated with the channel.

v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams.

Parameters:

streamConfigurationList - List of stream configurations associated with the channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-streamconfigurationlist

streamConfigurationList

@Stability(Stable)
public CfnChannel.Builder streamConfigurationList(List<? extends Object> streamConfigurationList)

List of stream configurations associated with the channel.

v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams.

Parameters:

streamConfigurationList - List of stream configurations associated with the channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-streamconfigurationlist

encryptionConfiguration

@Stability(Stable)
public CfnChannel.Builder encryptionConfiguration(IResolvable encryptionConfiguration)

Server-side encryption configuration for data at rest in the destination.

Data delivered to S3 / S3 Tables is encrypted with the same key.

Parameters:

encryptionConfiguration - Server-side encryption configuration for data at rest in the destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-encryptionconfiguration

encryptionConfiguration

@Stability(Stable)
public CfnChannel.Builder encryptionConfiguration(CfnChannel.EncryptionConfigurationProperty encryptionConfiguration)

Server-side encryption configuration for data at rest in the destination.

Data delivered to S3 / S3 Tables is encrypted with the same key.

Parameters:

encryptionConfiguration - Server-side encryption configuration for data at rest in the destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-encryptionconfiguration

loggingConfiguration

@Stability(Stable)
public CfnChannel.Builder loggingConfiguration(IResolvable loggingConfiguration)

Configuration for delivering channel operational logs.

Parameters:

loggingConfiguration - Configuration for delivering channel operational logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-loggingconfiguration

loggingConfiguration

@Stability(Stable)
public CfnChannel.Builder loggingConfiguration(CfnChannel.LoggingConfigurationProperty loggingConfiguration)

Configuration for delivering channel operational logs.

Parameters:

loggingConfiguration - Configuration for delivering channel operational logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-loggingconfiguration

s3DestinationConfiguration

@Stability(Stable)
public CfnChannel.Builder s3DestinationConfiguration(IResolvable s3DestinationConfiguration)

Configuration for delivery to a vanilla S3 bucket destination.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

Parameters:

s3DestinationConfiguration - Configuration for delivery to a vanilla S3 bucket destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3destinationconfiguration

s3DestinationConfiguration

@Stability(Stable)
public CfnChannel.Builder s3DestinationConfiguration(CfnChannel.S3DestinationConfigurationProperty s3DestinationConfiguration)

Configuration for delivery to a vanilla S3 bucket destination.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

Parameters:

s3DestinationConfiguration - Configuration for delivery to a vanilla S3 bucket destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3destinationconfiguration

s3TablesDestinationConfiguration

@Stability(Stable)
public CfnChannel.Builder s3TablesDestinationConfiguration(IResolvable s3TablesDestinationConfiguration)

Configuration for delivery to S3 Tables destinations.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

Parameters:

s3TablesDestinationConfiguration - Configuration for delivery to S3 Tables destinations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3tablesdestinationconfiguration

s3TablesDestinationConfiguration

@Stability(Stable)
public CfnChannel.Builder s3TablesDestinationConfiguration(CfnChannel.S3TablesDestinationConfigurationProperty s3TablesDestinationConfiguration)

Configuration for delivery to S3 Tables destinations.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

Parameters:

s3TablesDestinationConfiguration - Configuration for delivery to S3 Tables destinations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3tablesdestinationconfiguration

tags

@Stability(Stable)
public CfnChannel.Builder tags(List<? extends CfnTag> tags)

An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

Parameters:

tags - An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-tags

build

@Stability(Stable)
public CfnChannel build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnChannel>

Returns:

a newly built instance of CfnChannel.