Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api aws_apigatewayv2_api}.
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2Api;
Apigatewayv2Api.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>)
.name(java.lang.String)
.protocolType(java.lang.String)
// .apiKeySelectionExpression(java.lang.String)
// .body(java.lang.String)
// .corsConfiguration(Apigatewayv2ApiCorsConfiguration)
// .credentialsArn(java.lang.String)
// .description(java.lang.String)
// .disableExecuteApiEndpoint(java.lang.Boolean)
// .disableExecuteApiEndpoint(IResolvable)
// .failOnWarnings(java.lang.Boolean)
// .failOnWarnings(IResolvable)
// .id(java.lang.String)
// .routeKey(java.lang.String)
// .routeSelectionExpression(java.lang.String)
// .tags(java.util.Map<java.lang.String, java.lang.String>)
// .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
// .target(java.lang.String)
// .version(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. |
name |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}. |
protocolType |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}. |
apiKeySelectionExpression |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}. |
body |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}. |
corsConfiguration |
Apigatewayv2ApiCorsConfiguration |
cors_configuration block. |
credentialsArn |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}. |
description |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}. |
disableExecuteApiEndpoint |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}. |
failOnWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}. |
routeKey |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}. |
routeSelectionExpression |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}. |
tags |
java.util.Map<java.lang.String, java.lang.String> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}. |
tagsAll |
java.util.Map<java.lang.String, java.lang.String> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}. |
target |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}. |
version |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
cors_configuration block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#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.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
- Type: java.util.Map<java.lang.String, java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
- Type: java.util.Map<java.lang.String, java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.
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". |
putCorsConfiguration |
No description. |
resetApiKeySelectionExpression |
No description. |
resetBody |
No description. |
resetCorsConfiguration |
No description. |
resetCredentialsArn |
No description. |
resetDescription |
No description. |
resetDisableExecuteApiEndpoint |
No description. |
resetFailOnWarnings |
No description. |
resetId |
No description. |
resetRouteKey |
No description. |
resetRouteSelectionExpression |
No description. |
resetTags |
No description. |
resetTagsAll |
No description. |
resetTarget |
No description. |
resetVersion |
No description. |
public java.lang.String toString()
Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.
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.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
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.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
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.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
public void moveToId(java.lang.String id)
Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putCorsConfiguration(Apigatewayv2ApiCorsConfiguration value)
public void resetApiKeySelectionExpression()
public void resetBody()
public void resetCorsConfiguration()
public void resetCredentialsArn()
public void resetDescription()
public void resetDisableExecuteApiEndpoint()
public void resetFailOnWarnings()
public void resetId()
public void resetRouteKey()
public void resetRouteSelectionExpression()
public void resetTags()
public void resetTagsAll()
public void resetTarget()
public void resetVersion()
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a Apigatewayv2Api resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2Api;
Apigatewayv2Api.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.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2Api;
Apigatewayv2Api.isTerraformElement(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2Api;
Apigatewayv2Api.isTerraformResource(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2Api;
Apigatewayv2Api.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Apigatewayv2Api.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)
Generates CDKTF code for importing a Apigatewayv2Api resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the Apigatewayv2Api to import.
- Type: java.lang.String
The id of the existing Apigatewayv2Api that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the Apigatewayv2Api to import is found.
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. |
apiEndpoint |
java.lang.String |
No description. |
arn |
java.lang.String |
No description. |
corsConfiguration |
Apigatewayv2ApiCorsConfigurationOutputReference |
No description. |
executionArn |
java.lang.String |
No description. |
apiKeySelectionExpressionInput |
java.lang.String |
No description. |
bodyInput |
java.lang.String |
No description. |
corsConfigurationInput |
Apigatewayv2ApiCorsConfiguration |
No description. |
credentialsArnInput |
java.lang.String |
No description. |
descriptionInput |
java.lang.String |
No description. |
disableExecuteApiEndpointInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
failOnWarningsInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
idInput |
java.lang.String |
No description. |
nameInput |
java.lang.String |
No description. |
protocolTypeInput |
java.lang.String |
No description. |
routeKeyInput |
java.lang.String |
No description. |
routeSelectionExpressionInput |
java.lang.String |
No description. |
tagsAllInput |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
tagsInput |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
targetInput |
java.lang.String |
No description. |
versionInput |
java.lang.String |
No description. |
apiKeySelectionExpression |
java.lang.String |
No description. |
body |
java.lang.String |
No description. |
credentialsArn |
java.lang.String |
No description. |
description |
java.lang.String |
No description. |
disableExecuteApiEndpoint |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
failOnWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
id |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
protocolType |
java.lang.String |
No description. |
routeKey |
java.lang.String |
No description. |
routeSelectionExpression |
java.lang.String |
No description. |
tags |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
tagsAll |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
target |
java.lang.String |
No description. |
version |
java.lang.String |
No description. |
public Node getNode();
- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();
- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getApiEndpoint();
- Type: java.lang.String
public java.lang.String getArn();
- Type: java.lang.String
public Apigatewayv2ApiCorsConfigurationOutputReference getCorsConfiguration();
public java.lang.String getExecutionArn();
- Type: java.lang.String
public java.lang.String getApiKeySelectionExpressionInput();
- Type: java.lang.String
public java.lang.String getBodyInput();
- Type: java.lang.String
public Apigatewayv2ApiCorsConfiguration getCorsConfigurationInput();
public java.lang.String getCredentialsArnInput();
- Type: java.lang.String
public java.lang.String getDescriptionInput();
- Type: java.lang.String
public java.lang.Object getDisableExecuteApiEndpointInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getFailOnWarningsInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getIdInput();
- Type: java.lang.String
public java.lang.String getNameInput();
- Type: java.lang.String
public java.lang.String getProtocolTypeInput();
- Type: java.lang.String
public java.lang.String getRouteKeyInput();
- Type: java.lang.String
public java.lang.String getRouteSelectionExpressionInput();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.lang.String getTargetInput();
- Type: java.lang.String
public java.lang.String getVersionInput();
- Type: java.lang.String
public java.lang.String getApiKeySelectionExpression();
- Type: java.lang.String
public java.lang.String getBody();
- Type: java.lang.String
public java.lang.String getCredentialsArn();
- Type: java.lang.String
public java.lang.String getDescription();
- Type: java.lang.String
public java.lang.Object getDisableExecuteApiEndpoint();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getFailOnWarnings();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getId();
- Type: java.lang.String
public java.lang.String getName();
- Type: java.lang.String
public java.lang.String getProtocolType();
- Type: java.lang.String
public java.lang.String getRouteKey();
- Type: java.lang.String
public java.lang.String getRouteSelectionExpression();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getTags();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.lang.String getTarget();
- Type: java.lang.String
public java.lang.String getVersion();
- Type: java.lang.String
Name | Type | Description |
---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();
- Type: java.lang.String
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2ApiConfig;
Apigatewayv2ApiConfig.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>)
.name(java.lang.String)
.protocolType(java.lang.String)
// .apiKeySelectionExpression(java.lang.String)
// .body(java.lang.String)
// .corsConfiguration(Apigatewayv2ApiCorsConfiguration)
// .credentialsArn(java.lang.String)
// .description(java.lang.String)
// .disableExecuteApiEndpoint(java.lang.Boolean)
// .disableExecuteApiEndpoint(IResolvable)
// .failOnWarnings(java.lang.Boolean)
// .failOnWarnings(IResolvable)
// .id(java.lang.String)
// .routeKey(java.lang.String)
// .routeSelectionExpression(java.lang.String)
// .tags(java.util.Map<java.lang.String, java.lang.String>)
// .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
// .target(java.lang.String)
// .version(java.lang.String)
.build();
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. |
name |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}. |
protocolType |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}. |
apiKeySelectionExpression |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}. |
body |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}. |
corsConfiguration |
Apigatewayv2ApiCorsConfiguration |
cors_configuration block. |
credentialsArn |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}. |
description |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}. |
disableExecuteApiEndpoint |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}. |
failOnWarnings |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}. |
routeKey |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}. |
routeSelectionExpression |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}. |
tags |
java.util.Map<java.lang.String, java.lang.String> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}. |
tagsAll |
java.util.Map<java.lang.String, java.lang.String> |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}. |
target |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}. |
version |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}. |
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getName();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
public java.lang.String getProtocolType();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
public java.lang.String getApiKeySelectionExpression();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
public java.lang.String getBody();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
public Apigatewayv2ApiCorsConfiguration getCorsConfiguration();
cors_configuration block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}
public java.lang.String getCredentialsArn();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
public java.lang.String getDescription();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
public java.lang.Object getDisableExecuteApiEndpoint();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
public java.lang.Object getFailOnWarnings();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
public java.lang.String getId();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#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.
public java.lang.String getRouteKey();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
public java.lang.String getRouteSelectionExpression();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
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.89.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
- Type: java.util.Map<java.lang.String, java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
public java.lang.String getTarget();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
public java.lang.String getVersion();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2ApiCorsConfiguration;
Apigatewayv2ApiCorsConfiguration.builder()
// .allowCredentials(java.lang.Boolean)
// .allowCredentials(IResolvable)
// .allowHeaders(java.util.List<java.lang.String>)
// .allowMethods(java.util.List<java.lang.String>)
// .allowOrigins(java.util.List<java.lang.String>)
// .exposeHeaders(java.util.List<java.lang.String>)
// .maxAge(java.lang.Number)
.build();
public java.lang.Object getAllowCredentials();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.
public java.util.List<java.lang.String> getAllowHeaders();
- Type: java.util.List<java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.
public java.util.List<java.lang.String> getAllowMethods();
- Type: java.util.List<java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.
public java.util.List<java.lang.String> getAllowOrigins();
- Type: java.util.List<java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.
public java.util.List<java.lang.String> getExposeHeaders();
- Type: java.util.List<java.lang.String>
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.
public java.lang.Number getMaxAge();
- Type: java.lang.Number
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.89.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.
import com.hashicorp.cdktf.providers.aws.apigatewayv2_api.Apigatewayv2ApiCorsConfigurationOutputReference;
new Apigatewayv2ApiCorsConfigurationOutputReference(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. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
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. |
resetAllowCredentials |
No description. |
resetAllowHeaders |
No description. |
resetAllowMethods |
No description. |
resetAllowOrigins |
No description. |
resetExposeHeaders |
No description. |
resetMaxAge |
No description. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetAllowCredentials()
public void resetAllowHeaders()
public void resetAllowMethods()
public void resetAllowOrigins()
public void resetExposeHeaders()
public void resetMaxAge()
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. |
allowCredentialsInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
allowHeadersInput |
java.util.List<java.lang.String> |
No description. |
allowMethodsInput |
java.util.List<java.lang.String> |
No description. |
allowOriginsInput |
java.util.List<java.lang.String> |
No description. |
exposeHeadersInput |
java.util.List<java.lang.String> |
No description. |
maxAgeInput |
java.lang.Number |
No description. |
allowCredentials |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
allowHeaders |
java.util.List<java.lang.String> |
No description. |
allowMethods |
java.util.List<java.lang.String> |
No description. |
allowOrigins |
java.util.List<java.lang.String> |
No description. |
exposeHeaders |
java.util.List<java.lang.String> |
No description. |
maxAge |
java.lang.Number |
No description. |
internalValue |
Apigatewayv2ApiCorsConfiguration |
No description. |
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.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.Object getAllowCredentialsInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.util.List<java.lang.String> getAllowHeadersInput();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getAllowMethodsInput();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getAllowOriginsInput();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getExposeHeadersInput();
- Type: java.util.List<java.lang.String>
public java.lang.Number getMaxAgeInput();
- Type: java.lang.Number
public java.lang.Object getAllowCredentials();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.util.List<java.lang.String> getAllowHeaders();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getAllowMethods();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getAllowOrigins();
- Type: java.util.List<java.lang.String>
public java.util.List<java.lang.String> getExposeHeaders();
- Type: java.util.List<java.lang.String>
public java.lang.Number getMaxAge();
- Type: java.lang.Number
public Apigatewayv2ApiCorsConfiguration getInternalValue();