Skip to content

Latest commit

 

History

History
1865 lines (1161 loc) · 81.3 KB

kmsGrant.java.md

File metadata and controls

1865 lines (1161 loc) · 81.3 KB
Raw

kmsGrant Submodule

Constructs

KmsGrant

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant aws_kms_grant}.

Initializers 

import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrant;

KmsGrant.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .granteePrincipal(java.lang.String)
    .keyId(java.lang.String)
    .operations(java.util.List<java.lang.String>)
//  .constraints(IResolvable)
//  .constraints(java.util.List<KmsGrantConstraints>)
//  .grantCreationTokens(java.util.List<java.lang.String>)
//  .id(java.lang.String)
//  .name(java.lang.String)
//  .retireOnDelete(java.lang.Boolean)
//  .retireOnDelete(IResolvable)
//  .retiringPrincipal(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
granteePrincipal java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grantee_principal KmsGrant#grantee_principal}.
keyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#key_id KmsGrant#key_id}.
operations java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#operations KmsGrant#operations}.
constraints com.hashicorp.cdktf.IResolvable OR java.util.List<KmsGrantConstraints> constraints block.
grantCreationTokens java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grant_creation_tokens KmsGrant#grant_creation_tokens}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#id KmsGrant#id}.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#name KmsGrant#name}.
retireOnDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retire_on_delete KmsGrant#retire_on_delete}.
retiringPrincipal java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retiring_principal KmsGrant#retiring_principal}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
granteePrincipalRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grantee_principal KmsGrant#grantee_principal}.

keyIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#key_id KmsGrant#key_id}.

operationsRequired
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#operations KmsGrant#operations}.

constraintsOptional

constraints block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#constraints KmsGrant#constraints}

grantCreationTokensOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grant_creation_tokens KmsGrant#grant_creation_tokens}.

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#id KmsGrant#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

nameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#name KmsGrant#name}.

retireOnDeleteOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retire_on_delete KmsGrant#retire_on_delete}.

retiringPrincipalOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retiring_principal KmsGrant#retiring_principal}.

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putConstraints No description.
resetConstraints No description.
resetGrantCreationTokens No description.
resetId No description.
resetName No description.
resetRetireOnDelete No description.
resetRetiringPrincipal No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putConstraints 
public void putConstraints(IResolvable OR java.util.List<KmsGrantConstraints> value)
valueRequired
resetConstraints 
public void resetConstraints()
resetGrantCreationTokens 
public void resetGrantCreationTokens()
resetId 
public void resetId()
resetName 
public void resetName()
resetRetireOnDelete 
public void resetRetireOnDelete()
resetRetiringPrincipal 
public void resetRetiringPrincipal()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a KmsGrant resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrant;

KmsGrant.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrant;

KmsGrant.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrant;

KmsGrant.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrant;

KmsGrant.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),KmsGrant.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a KmsGrant resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the KmsGrant to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing KmsGrant that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the KmsGrant to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
constraints KmsGrantConstraintsList No description.
grantId java.lang.String No description.
grantToken java.lang.String No description.
constraintsInput com.hashicorp.cdktf.IResolvable OR java.util.List<KmsGrantConstraints> No description.
grantCreationTokensInput java.util.List<java.lang.String> No description.
granteePrincipalInput java.lang.String No description.
idInput java.lang.String No description.
keyIdInput java.lang.String No description.
nameInput java.lang.String No description.
operationsInput java.util.List<java.lang.String> No description.
retireOnDeleteInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retiringPrincipalInput java.lang.String No description.
grantCreationTokens java.util.List<java.lang.String> No description.
granteePrincipal java.lang.String No description.
id java.lang.String No description.
keyId java.lang.String No description.
name java.lang.String No description.
operations java.util.List<java.lang.String> No description.
retireOnDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
retiringPrincipal java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
constraintsRequired 
public KmsGrantConstraintsList getConstraints();
grantIdRequired 
public java.lang.String getGrantId();
  • Type: java.lang.String
grantTokenRequired 
public java.lang.String getGrantToken();
  • Type: java.lang.String
constraintsInputOptional 
public java.lang.Object getConstraintsInput();
grantCreationTokensInputOptional 
public java.util.List<java.lang.String> getGrantCreationTokensInput();
  • Type: java.util.List<java.lang.String>
granteePrincipalInputOptional 
public java.lang.String getGranteePrincipalInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
keyIdInputOptional 
public java.lang.String getKeyIdInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
operationsInputOptional 
public java.util.List<java.lang.String> getOperationsInput();
  • Type: java.util.List<java.lang.String>
retireOnDeleteInputOptional 
public java.lang.Object getRetireOnDeleteInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retiringPrincipalInputOptional 
public java.lang.String getRetiringPrincipalInput();
  • Type: java.lang.String
grantCreationTokensRequired 
public java.util.List<java.lang.String> getGrantCreationTokens();
  • Type: java.util.List<java.lang.String>
granteePrincipalRequired 
public java.lang.String getGranteePrincipal();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
keyIdRequired 
public java.lang.String getKeyId();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
operationsRequired 
public java.util.List<java.lang.String> getOperations();
  • Type: java.util.List<java.lang.String>
retireOnDeleteRequired 
public java.lang.Object getRetireOnDelete();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
retiringPrincipalRequired 
public java.lang.String getRetiringPrincipal();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

KmsGrantConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrantConfig;

KmsGrantConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .granteePrincipal(java.lang.String)
    .keyId(java.lang.String)
    .operations(java.util.List<java.lang.String>)
//  .constraints(IResolvable)
//  .constraints(java.util.List<KmsGrantConstraints>)
//  .grantCreationTokens(java.util.List<java.lang.String>)
//  .id(java.lang.String)
//  .name(java.lang.String)
//  .retireOnDelete(java.lang.Boolean)
//  .retireOnDelete(IResolvable)
//  .retiringPrincipal(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
granteePrincipal java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grantee_principal KmsGrant#grantee_principal}.
keyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#key_id KmsGrant#key_id}.
operations java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#operations KmsGrant#operations}.
constraints com.hashicorp.cdktf.IResolvable OR java.util.List<KmsGrantConstraints> constraints block.
grantCreationTokens java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grant_creation_tokens KmsGrant#grant_creation_tokens}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#id KmsGrant#id}.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#name KmsGrant#name}.
retireOnDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retire_on_delete KmsGrant#retire_on_delete}.
retiringPrincipal java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retiring_principal KmsGrant#retiring_principal}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
granteePrincipalRequired 
public java.lang.String getGranteePrincipal();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grantee_principal KmsGrant#grantee_principal}.

keyIdRequired 
public java.lang.String getKeyId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#key_id KmsGrant#key_id}.

operationsRequired 
public java.util.List<java.lang.String> getOperations();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#operations KmsGrant#operations}.

constraintsOptional 
public java.lang.Object getConstraints();

constraints block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#constraints KmsGrant#constraints}

grantCreationTokensOptional 
public java.util.List<java.lang.String> getGrantCreationTokens();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#grant_creation_tokens KmsGrant#grant_creation_tokens}.

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#id KmsGrant#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

nameOptional 
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#name KmsGrant#name}.

retireOnDeleteOptional 
public java.lang.Object getRetireOnDelete();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retire_on_delete KmsGrant#retire_on_delete}.

retiringPrincipalOptional 
public java.lang.String getRetiringPrincipal();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#retiring_principal KmsGrant#retiring_principal}.

KmsGrantConstraints

Initializer 

import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrantConstraints;

KmsGrantConstraints.builder()
//  .encryptionContextEquals(java.util.Map<java.lang.String, java.lang.String>)
//  .encryptionContextSubset(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
encryptionContextEquals java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#encryption_context_equals KmsGrant#encryption_context_equals}.
encryptionContextSubset java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#encryption_context_subset KmsGrant#encryption_context_subset}.
encryptionContextEqualsOptional 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextEquals();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#encryption_context_equals KmsGrant#encryption_context_equals}.

encryptionContextSubsetOptional 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextSubset();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/kms_grant#encryption_context_subset KmsGrant#encryption_context_subset}.

Classes

KmsGrantConstraintsList

Initializers 

import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrantConstraintsList;

new KmsGrantConstraintsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public KmsGrantConstraintsOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<KmsGrantConstraints> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

KmsGrantConstraintsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.aws.kms_grant.KmsGrantConstraintsOutputReference;

new KmsGrantConstraintsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetEncryptionContextEquals No description.
resetEncryptionContextSubset No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetEncryptionContextEquals 
public void resetEncryptionContextEquals()
resetEncryptionContextSubset 
public void resetEncryptionContextSubset()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
encryptionContextEqualsInput java.util.Map<java.lang.String, java.lang.String> No description.
encryptionContextSubsetInput java.util.Map<java.lang.String, java.lang.String> No description.
encryptionContextEquals java.util.Map<java.lang.String, java.lang.String> No description.
encryptionContextSubset java.util.Map<java.lang.String, java.lang.String> No description.
internalValue com.hashicorp.cdktf.IResolvable OR KmsGrantConstraints No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
encryptionContextEqualsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextEqualsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
encryptionContextSubsetInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextSubsetInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
encryptionContextEqualsRequired 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextEquals();
  • Type: java.util.Map<java.lang.String, java.lang.String>
encryptionContextSubsetRequired 
public java.util.Map<java.lang.String, java.lang.String> getEncryptionContextSubset();
  • Type: java.util.Map<java.lang.String, java.lang.String>
internalValueOptional 
public java.lang.Object getInternalValue();