Skip to content

Latest commit

 

History

History
2000 lines (1243 loc) · 89 KB

dataAwsKeyPair.java.md

File metadata and controls

2000 lines (1243 loc) · 89 KB

dataAwsKeyPair Submodule

Constructs

DataAwsKeyPair

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair aws_key_pair}.

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPair;

DataAwsKeyPair.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>)
//  .filter(IResolvable)
//  .filter(java.util.List<DataAwsKeyPairFilter>)
//  .id(java.lang.String)
//  .includePublicKey(java.lang.Boolean)
//  .includePublicKey(IResolvable)
//  .keyName(java.lang.String)
//  .keyPairId(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(DataAwsKeyPairTimeouts)
    .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.
filter com.hashicorp.cdktf.IResolvable OR java.util.List<DataAwsKeyPairFilter> filter block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#id DataAwsKeyPair#id}.
includePublicKey java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#include_public_key DataAwsKeyPair#include_public_key}.
keyName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_name DataAwsKeyPair#key_name}.
keyPairId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_pair_id DataAwsKeyPair#key_pair_id}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#tags DataAwsKeyPair#tags}.
timeouts DataAwsKeyPairTimeouts timeouts block.

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>

filterOptional

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#filter DataAwsKeyPair#filter}


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#id DataAwsKeyPair#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.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#include_public_key DataAwsKeyPair#include_public_key}.


keyNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_name DataAwsKeyPair#key_name}.


keyPairIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_pair_id DataAwsKeyPair#key_pair_id}.


tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#tags DataAwsKeyPair#tags}.


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#timeouts DataAwsKeyPair#timeouts}


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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putFilter No description.
putTimeouts No description.
resetFilter No description.
resetId No description.
resetIncludePublicKey No description.
resetKeyName No description.
resetKeyPairId No description.
resetTags No description.
resetTimeouts 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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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 terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

putFilter
public void putFilter(IResolvable OR java.util.List<DataAwsKeyPairFilter> value)
valueRequired

putTimeouts
public void putTimeouts(DataAwsKeyPairTimeouts value)
valueRequired

resetFilter
public void resetFilter()
resetId
public void resetId()
resetIncludePublicKey
public void resetIncludePublicKey()
resetKeyName
public void resetKeyName()
resetKeyPairId
public void resetKeyPairId()
resetTags
public void resetTags()
resetTimeouts
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataAwsKeyPair resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPair;

DataAwsKeyPair.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.data_aws_key_pair.DataAwsKeyPair;

DataAwsKeyPair.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformDataSource
import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPair;

DataAwsKeyPair.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPair;

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

Generates CDKTF code for importing a DataAwsKeyPair 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 DataAwsKeyPair to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing DataAwsKeyPair that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#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 DataAwsKeyPair 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.
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.
arn java.lang.String No description.
createTime java.lang.String No description.
filter DataAwsKeyPairFilterList No description.
fingerprint java.lang.String No description.
keyType java.lang.String No description.
publicKey java.lang.String No description.
timeouts DataAwsKeyPairTimeoutsOutputReference No description.
filterInput com.hashicorp.cdktf.IResolvable OR java.util.List<DataAwsKeyPairFilter> No description.
idInput java.lang.String No description.
includePublicKeyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
keyNameInput java.lang.String No description.
keyPairIdInput java.lang.String No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR DataAwsKeyPairTimeouts No description.
id java.lang.String No description.
includePublicKey java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
keyName java.lang.String No description.
keyPairId java.lang.String No description.
tags java.util.Map<java.lang.String, 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

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

arnRequired
public java.lang.String getArn();
  • Type: java.lang.String

createTimeRequired
public java.lang.String getCreateTime();
  • Type: java.lang.String

filterRequired
public DataAwsKeyPairFilterList getFilter();

fingerprintRequired
public java.lang.String getFingerprint();
  • Type: java.lang.String

keyTypeRequired
public java.lang.String getKeyType();
  • Type: java.lang.String

publicKeyRequired
public java.lang.String getPublicKey();
  • Type: java.lang.String

timeoutsRequired
public DataAwsKeyPairTimeoutsOutputReference getTimeouts();

filterInputOptional
public java.lang.Object getFilterInput();

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

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

keyNameInputOptional
public java.lang.String getKeyNameInput();
  • Type: java.lang.String

keyPairIdInputOptional
public java.lang.String getKeyPairIdInput();
  • Type: java.lang.String

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

timeoutsInputOptional
public java.lang.Object getTimeoutsInput();

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

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

keyNameRequired
public java.lang.String getKeyName();
  • Type: java.lang.String

keyPairIdRequired
public java.lang.String getKeyPairId();
  • Type: java.lang.String

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

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DataAwsKeyPairConfig

Initializer

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairConfig;

DataAwsKeyPairConfig.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>)
//  .filter(IResolvable)
//  .filter(java.util.List<DataAwsKeyPairFilter>)
//  .id(java.lang.String)
//  .includePublicKey(java.lang.Boolean)
//  .includePublicKey(IResolvable)
//  .keyName(java.lang.String)
//  .keyPairId(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(DataAwsKeyPairTimeouts)
    .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.
filter com.hashicorp.cdktf.IResolvable OR java.util.List<DataAwsKeyPairFilter> filter block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#id DataAwsKeyPair#id}.
includePublicKey java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#include_public_key DataAwsKeyPair#include_public_key}.
keyName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_name DataAwsKeyPair#key_name}.
keyPairId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_pair_id DataAwsKeyPair#key_pair_id}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#tags DataAwsKeyPair#tags}.
timeouts DataAwsKeyPairTimeouts timeouts block.

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>

filterOptional
public java.lang.Object getFilter();

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#filter DataAwsKeyPair#filter}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#id DataAwsKeyPair#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.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#include_public_key DataAwsKeyPair#include_public_key}.


keyNameOptional
public java.lang.String getKeyName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_name DataAwsKeyPair#key_name}.


keyPairIdOptional
public java.lang.String getKeyPairId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#key_pair_id DataAwsKeyPair#key_pair_id}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#tags DataAwsKeyPair#tags}.


timeoutsOptional
public DataAwsKeyPairTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#timeouts DataAwsKeyPair#timeouts}


DataAwsKeyPairFilter

Initializer

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairFilter;

DataAwsKeyPairFilter.builder()
    .name(java.lang.String)
    .values(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#name DataAwsKeyPair#name}.
values java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#values DataAwsKeyPair#values}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#name DataAwsKeyPair#name}.


valuesRequired
public java.util.List<java.lang.String> getValues();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#values DataAwsKeyPair#values}.


DataAwsKeyPairTimeouts

Initializer

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairTimeouts;

DataAwsKeyPairTimeouts.builder()
//  .read(java.lang.String)
    .build();

Properties

Name Type Description
read java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#read DataAwsKeyPair#read}.

readOptional
public java.lang.String getRead();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/key_pair#read DataAwsKeyPair#read}.


Classes

DataAwsKeyPairFilterList

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairFilterList;

new DataAwsKeyPairFilterList(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 DataAwsKeyPairFilterOutputReference 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<DataAwsKeyPairFilter> 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();

DataAwsKeyPairFilterOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairFilterOutputReference;

new DataAwsKeyPairFilterOutputReference(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.

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.

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.
nameInput java.lang.String No description.
valuesInput java.util.List<java.lang.String> No description.
name java.lang.String No description.
values java.util.List<java.lang.String> No description.
internalValue com.hashicorp.cdktf.IResolvable OR DataAwsKeyPairFilter 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

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

valuesInputOptional
public java.util.List<java.lang.String> getValuesInput();
  • Type: java.util.List<java.lang.String>

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

valuesRequired
public java.util.List<java.lang.String> getValues();
  • Type: java.util.List<java.lang.String>

internalValueOptional
public java.lang.Object getInternalValue();

DataAwsKeyPairTimeoutsOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_key_pair.DataAwsKeyPairTimeoutsOutputReference;

new DataAwsKeyPairTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


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.
resetRead 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.

resetRead
public void resetRead()

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.
readInput java.lang.String No description.
read java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR DataAwsKeyPairTimeouts 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

readInputOptional
public java.lang.String getReadInput();
  • Type: java.lang.String

readRequired
public java.lang.String getRead();
  • Type: java.lang.String

internalValueOptional
public java.lang.Object getInternalValue();