Package software.amazon.awssdk.services.securityhub.model

Interface AwsKmsKeyDetails.Builder

    • Method Detail

      • awsAccountId

        AwsKmsKeyDetails.Builder awsAccountId​(String awsAccountId)

        The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

        Parameters:
        awsAccountId - The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        AwsKmsKeyDetails.Builder creationDate​(Double creationDate)

        Indicates when the KMS key was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        creationDate - Indicates when the KMS key was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • keyId

        AwsKmsKeyDetails.Builder keyId​(String keyId)

        The globally unique identifier for the KMS key.

        Parameters:
        keyId - The globally unique identifier for the KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyManager

        AwsKmsKeyDetails.Builder keyManager​(String keyManager)

        The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

        Parameters:
        keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyState

        AwsKmsKeyDetails.Builder keyState​(String keyState)

        The state of the KMS key. Valid values are as follows:

        • Disabled

        • Enabled

        • PendingDeletion

        • PendingImport

        • Unavailable

        Parameters:
        keyState - The state of the KMS key. Valid values are as follows:

        • Disabled

        • Enabled

        • PendingDeletion

        • PendingImport

        • Unavailable

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

      • origin

        AwsKmsKeyDetails.Builder origin​(String origin)

        The source of the KMS key material.

        When this value is AWS_KMS, KMS created the key material.

        When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

        When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

        Parameters:
        origin - The source of the KMS key material.

        When this value is AWS_KMS, KMS created the key material.

        When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

        When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

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

      • description

        AwsKmsKeyDetails.Builder description​(String description)

        A description of the KMS key.

        Parameters:
        description - A description of the KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyRotationStatus

        AwsKmsKeyDetails.Builder keyRotationStatus​(Boolean keyRotationStatus)

        Whether the key has key rotation enabled.

        Parameters:
        keyRotationStatus - Whether the key has key rotation enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.