Package com.pulumi.aws.kms.inputs

Class GrantState

  • public final class GrantState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GrantState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static GrantState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static GrantState.Builder builder()  
      static GrantState.Builder builder​(GrantState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.util.List<GrantConstraintArgs>>> constraints()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> grantCreationTokens()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> granteePrincipal()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> grantId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> grantToken()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> operations()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> retireOnDelete()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> retiringPrincipal()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • constraints

        public java.util.Optional<com.pulumi.core.Output<java.util.List<GrantConstraintArgs>>> constraints()
        Returns:
        Structure that you can use to allow certain operations in the grant only when the desired encryption context is present. See `constraints` Block for details. For more information about encryption context, see [Encryption Context](https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html).

      • grantCreationTokens

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> grantCreationTokens()
        Returns:
        List of grant tokens to be used when creating the grant. See [Grant Tokens](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) for more information about grant tokens.

      • grantId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> grantId()
        Returns:
        Unique identifier for the grant.

      • grantToken

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> grantToken()
        Returns:
        Grant token for the created grant. For more information, see [Grant Tokens](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token).

      • granteePrincipal

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> granteePrincipal()
        Returns:
        Principal that is given permission to perform the operations that the grant permits in ARN format. Note that due to eventual consistency issues around IAM principals, Terraform's state may not always be refreshed to reflect what is true in AWS.

      • keyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyId()
        Returns:
        Unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the ARN of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Friendly name for identifying the grant.

      • operations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> operations()
        Returns:
        List of operations that the grant permits. The permitted values are: `Decrypt`, `Encrypt`, `GenerateDataKey`, `GenerateDataKeyWithoutPlaintext`, `ReEncryptFrom`, `ReEncryptTo`, `Sign`, `Verify`, `GetPublicKey`, `CreateGrant`, `RetireGrant`, `DescribeKey`, `GenerateDataKeyPair`, or `GenerateDataKeyPairWithoutPlaintext`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • retireOnDelete

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> retireOnDelete()
        Returns:
        If set to false (the default) the grants will be revoked upon deletion, and if set to true the grants will try to be retired upon deletion. Note that retiring grants requires special permissions, hence why we default to revoking grants. See [RetireGrant](https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html) for more information.

      • retiringPrincipal

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> retiringPrincipal()
        Returns:
        Principal that is given permission to retire the grant by using RetireGrant operation in ARN format. Note that due to eventual consistency issues around IAM principals, Terraform's state may not always be refreshed to reflect what is true in AWS.