Skip to content

workersKv.java.md

Latest commit

 

History

History
1121 lines (694 loc) · 45.5 KB

workersKv.java.md

File metadata and controls

1121 lines (694 loc) · 45.5 KB

workersKv Submodule

Constructs

WorkersKv

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv cloudflare_workers_kv}.

Initializers 

import io.cdktn.providers.cloudflare.workers_kv.WorkersKv;

WorkersKv.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .keyName(java.lang.String)
    .namespaceId(java.lang.String)
    .value(java.lang.String)
//  .accountId(java.lang.String)
//  .metadata(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 io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
keyName java.lang.String A key's name.
namespaceId java.lang.String Namespace identifier tag.
value java.lang.String A byte sequence to be stored, up to 25 MiB in length.
accountId java.lang.String Identifier.
metadata java.lang.String Associates arbitrary JSON data with a key/value pair.
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: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
keyNameRequired
  • Type: java.lang.String

A key's name.

The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#key_name WorkersKv#key_name}

namespaceIdRequired
  • Type: java.lang.String

Namespace identifier tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#namespace_id WorkersKv#namespace_id}

valueRequired
  • Type: java.lang.String

A byte sequence to be stored, up to 25 MiB in length.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#value WorkersKv#value}

accountIdOptional
  • Type: java.lang.String

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#account_id WorkersKv#account_id}

metadataOptional
  • Type: java.lang.String

Associates arbitrary JSON data with a key/value pair.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#metadata WorkersKv#metadata}

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to 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".
resetAccountId No description.
resetMetadata No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

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|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: io.cdktn.cdktn.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|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|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".

resetAccountId 
public void resetAccountId()
resetMetadata 
public void resetMetadata()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a WorkersKv resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.cloudflare.workers_kv.WorkersKv;

WorkersKv.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 io.cdktn.providers.cloudflare.workers_kv.WorkersKv;

WorkersKv.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import io.cdktn.providers.cloudflare.workers_kv.WorkersKv;

WorkersKv.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.cloudflare.workers_kv.WorkersKv;

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

Generates CDKTN code for importing a WorkersKv resource upon running "cdktn 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 WorkersKv to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing WorkersKv that should be imported.

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

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.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 io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
id java.lang.String No description.
accountIdInput java.lang.String No description.
keyNameInput java.lang.String No description.
metadataInput java.lang.String No description.
namespaceIdInput java.lang.String No description.
valueInput java.lang.String No description.
accountId java.lang.String No description.
keyName java.lang.String No description.
metadata java.lang.String No description.
namespaceId java.lang.String No description.
value java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.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: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
accountIdInputOptional 
public java.lang.String getAccountIdInput();
  • Type: java.lang.String
keyNameInputOptional 
public java.lang.String getKeyNameInput();
  • Type: java.lang.String
metadataInputOptional 
public java.lang.String getMetadataInput();
  • Type: java.lang.String
namespaceIdInputOptional 
public java.lang.String getNamespaceIdInput();
  • Type: java.lang.String
valueInputOptional 
public java.lang.String getValueInput();
  • Type: java.lang.String
accountIdRequired 
public java.lang.String getAccountId();
  • Type: java.lang.String
keyNameRequired 
public java.lang.String getKeyName();
  • Type: java.lang.String
metadataRequired 
public java.lang.String getMetadata();
  • Type: java.lang.String
namespaceIdRequired 
public java.lang.String getNamespaceId();
  • Type: java.lang.String
valueRequired 
public java.lang.String getValue();
  • 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

WorkersKvConfig

Initializer 

import io.cdktn.providers.cloudflare.workers_kv.WorkersKvConfig;

WorkersKvConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .keyName(java.lang.String)
    .namespaceId(java.lang.String)
    .value(java.lang.String)
//  .accountId(java.lang.String)
//  .metadata(java.lang.String)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
keyName java.lang.String A key's name.
namespaceId java.lang.String Namespace identifier tag.
value java.lang.String A byte sequence to be stored, up to 25 MiB in length.
accountId java.lang.String Identifier.
metadata java.lang.String Associates arbitrary JSON data with a key/value pair.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
keyNameRequired 
public java.lang.String getKeyName();
  • Type: java.lang.String

A key's name.

The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#key_name WorkersKv#key_name}

namespaceIdRequired 
public java.lang.String getNamespaceId();
  • Type: java.lang.String

Namespace identifier tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#namespace_id WorkersKv#namespace_id}

valueRequired 
public java.lang.String getValue();
  • Type: java.lang.String

A byte sequence to be stored, up to 25 MiB in length.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#value WorkersKv#value}

accountIdOptional 
public java.lang.String getAccountId();
  • Type: java.lang.String

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#account_id WorkersKv#account_id}

metadataOptional 
public java.lang.String getMetadata();
  • Type: java.lang.String

Associates arbitrary JSON data with a key/value pair.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/workers_kv#metadata WorkersKv#metadata}