Package software.amazon.awssdk.services.kinesis.model

Interface StartStreamEncryptionRequest.Builder

    • Method Detail

      • 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, EncryptionType

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