Interface StartStreamEncryptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>, KinesisRequest.Builder, SdkBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartStreamEncryptionRequest
public static interface StartStreamEncryptionRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>

  • Method Details

    • streamName

      StartStreamEncryptionRequest.Builder streamName(String streamName)

      The name of the stream for which to start encrypting records.

      Parameters:
      streamName - The name of the stream for which to start encrypting records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionType

      StartStreamEncryptionRequest.Builder encryptionType(String encryptionType)

      The encryption type to use. The only valid value is KMS.

      Parameters:
      encryptionType - The encryption type to use. The only valid value is KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionType

      StartStreamEncryptionRequest.Builder encryptionType(EncryptionType encryptionType)

      The encryption type to use. The only valid value is KMS.

      Parameters:
      encryptionType - The encryption type to use. The only valid value is KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyId

      StartStreamEncryptionRequest.Builder keyId(String keyId)

      The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

      • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

      • Alias name example: alias/MyAliasName

      • Master key owned by Kinesis Data Streams: alias/aws/kinesis

      Parameters:
      keyId - The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

      • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

      • Alias name example: alias/MyAliasName

      • Master key owned by Kinesis Data Streams: alias/aws/kinesis

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

    • streamARN

      StartStreamEncryptionRequest.Builder streamARN(String streamARN)

      The ARN of the stream.

      Parameters:
      streamARN - The ARN of the stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartStreamEncryptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartStreamEncryptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.