GrantState class

Input properties used for looking up and filtering Grant resources.

Constructors

GrantState({Input<List<GrantConstraint>?>? constraints, Input<List<String>?>? grantCreationTokens, Input<String?>? grantId, Input<String?>? grantToken, Input<String?>? granteePrincipal, Input<String?>? keyId, Input<String?>? name, Input<List<String>?>? operations, Input<String?>? region, Input<bool?>? retireOnDelete, Input<String?>? retiringPrincipal})
Creates a new GrantState. constraints A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context. grantCreationTokens A list of grant tokens to be used when creating the grant. See Grant Tokens for more information about grant tokens. grantId The unique identifier for the grant. grantToken The grant token for the created grant. For more information, see Grant Tokens. granteePrincipal The 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, the providers's state may not always be refreshed to reflect what is true in AWS. keyId 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 A friendly name for identifying the grant. operations A 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 Region where this resource will be managed. Defaults to the Region set in the provider configuration. retireOnDelete 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. retiringPrincipal The 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, the providers's state may not always be refreshed to reflect what is true in AWS.
const
GrantState.fromMap(Map<String, dynamic> map)
factory

Properties

constraints → Input<List<GrantConstraint>?>?
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context.
final
grantCreationTokens → Input<List<String>?>?
A list of grant tokens to be used when creating the grant. See Grant Tokens for more information about grant tokens.
final
granteePrincipal → Input<String?>?
The 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, the providers's state may not always be refreshed to reflect what is true in AWS.
final
grantId → Input<String?>?
The unique identifier for the grant.
final
grantToken → Input<String?>?
The grant token for the created grant. For more information, see Grant Tokens.
final
hashCode → int
The hash code for this object.
no setterinherited
keyId → Input<String?>?
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.
final
name → Input<String?>?
A friendly name for identifying the grant.
final
operations → Input<List<String>?>?
A 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.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
retireOnDelete → Input<bool?>?
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 for more information.
final
retiringPrincipal → Input<String?>?
The 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, the providers's state may not always be refreshed to reflect what is true in AWS.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited