Class CreateGrantRequest

    • Constructor Detail

      • CreateGrantRequest

        public CreateGrantRequest()
    • Method Detail

      • setKeyId

        public void setKeyId​(String keyId)

        The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012

        Parameters:
        keyId - The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234- 1234-123456789012

      • getKeyId

        public String getKeyId()

        The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012

        Returns:
        The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234 -1234-123456789012

      • withKeyId

        public CreateGrantRequest withKeyId​(String keyId)

        The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012

        Parameters:
        keyId - The unique identifier for the customer master key (CMK) that the grant applies to.

        To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

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

        • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234- 1234-123456789012

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

        public void setGranteePrincipal​(String granteePrincipal)

        The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Parameters:
        granteePrincipal - The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

      • getGranteePrincipal

        public String getGranteePrincipal()

        The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Returns:
        The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

      • withGranteePrincipal

        public CreateGrantRequest withGranteePrincipal​(String granteePrincipal)

        The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Parameters:
        granteePrincipal - The principal that is given permission to perform the operations that the grant permits.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

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

        public void setRetiringPrincipal​(String retiringPrincipal)

        The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Parameters:
        retiringPrincipal - The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

      • getRetiringPrincipal

        public String getRetiringPrincipal()

        The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Returns:
        The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

      • withRetiringPrincipal

        public CreateGrantRequest withRetiringPrincipal​(String retiringPrincipal)

        The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

        Parameters:
        retiringPrincipal - The principal that is given permission to retire the grant by using RetireGrant operation.

        To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

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

        public void setConstraints​(GrantConstraints constraints)

        The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

        Parameters:
        constraints - The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

      • getConstraints

        public GrantConstraints getConstraints()

        The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

        Returns:
        The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

      • withConstraints

        public CreateGrantRequest withConstraints​(GrantConstraints constraints)

        The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

        Parameters:
        constraints - The conditions under which the operations permitted by the grant are allowed.

        You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

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

        public List<String> getGrantTokens()

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Returns:
        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

      • setGrantTokens

        public void setGrantTokens​(Collection<String> grantTokens)

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

      • withGrantTokens

        public CreateGrantRequest withGrantTokens​(String... grantTokens)

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

        Parameters:
        grantTokens - A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

        public CreateGrantRequest withGrantTokens​(Collection<String> grantTokens)

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

        public void setName​(String name)

        A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

        Parameters:
        name - A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

      • getName

        public String getName()

        A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

        Returns:
        A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

      • withName

        public CreateGrantRequest withName​(String name)

        A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

        Parameters:
        name - A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

        When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

        When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

        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; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object