Skip to content

Latest commit

 

History

History
2089 lines (1312 loc) · 105 KB

apiGatewayIntegration.java.md

File metadata and controls

2089 lines (1312 loc) · 105 KB

apiGatewayIntegration Submodule

Constructs

ApiGatewayIntegration

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration aws_api_gateway_integration}.

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegration;

ApiGatewayIntegration.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>)
    .httpMethod(java.lang.String)
    .resourceId(java.lang.String)
    .restApiId(java.lang.String)
    .type(java.lang.String)
//  .cacheKeyParameters(java.util.List<java.lang.String>)
//  .cacheNamespace(java.lang.String)
//  .connectionId(java.lang.String)
//  .connectionType(java.lang.String)
//  .contentHandling(java.lang.String)
//  .credentials(java.lang.String)
//  .id(java.lang.String)
//  .integrationHttpMethod(java.lang.String)
//  .passthroughBehavior(java.lang.String)
//  .requestParameters(java.util.Map<java.lang.String, java.lang.String>)
//  .requestTemplates(java.util.Map<java.lang.String, java.lang.String>)
//  .timeoutMilliseconds(java.lang.Number)
//  .tlsConfig(ApiGatewayIntegrationTlsConfig)
//  .uri(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.
httpMethod java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.
resourceId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.
restApiId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.
type java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.
cacheKeyParameters java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.
cacheNamespace java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.
connectionId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.
connectionType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.
contentHandling java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.
credentials java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#id}.
integrationHttpMethod java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.
passthroughBehavior java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.
requestParameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.
requestTemplates java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.
timeoutMilliseconds java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.
tlsConfig ApiGatewayIntegrationTlsConfig tls_config block.
uri java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

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>

httpMethodRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.


resourceIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.


restApiIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.


typeRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.


cacheNamespaceOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.


connectionIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.


connectionTypeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.


contentHandlingOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.


credentialsOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#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.


integrationHttpMethodOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.


passthroughBehaviorOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.


timeoutMillisecondsOptional
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.


tlsConfigOptional

tls_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#tls_config ApiGatewayIntegration#tls_config}


uriOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.


Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTlsConfig No description.
resetCacheKeyParameters No description.
resetCacheNamespace No description.
resetConnectionId No description.
resetConnectionType No description.
resetContentHandling No description.
resetCredentials No description.
resetId No description.
resetIntegrationHttpMethod No description.
resetPassthroughBehavior No description.
resetRequestParameters No description.
resetRequestTemplates No description.
resetTimeoutMilliseconds No description.
resetTlsConfig No description.
resetUri No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

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

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

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

Adds this resource to the terraform JSON output.

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

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

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

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

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

idRequired
  • Type: java.lang.String

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


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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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


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

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


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

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

idRequired
  • Type: java.lang.String

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


putTlsConfig
public void putTlsConfig(ApiGatewayIntegrationTlsConfig value)
valueRequired

resetCacheKeyParameters
public void resetCacheKeyParameters()
resetCacheNamespace
public void resetCacheNamespace()
resetConnectionId
public void resetConnectionId()
resetConnectionType
public void resetConnectionType()
resetContentHandling
public void resetContentHandling()
resetCredentials
public void resetCredentials()
resetId
public void resetId()
resetIntegrationHttpMethod
public void resetIntegrationHttpMethod()
resetPassthroughBehavior
public void resetPassthroughBehavior()
resetRequestParameters
public void resetRequestParameters()
resetRequestTemplates
public void resetRequestTemplates()
resetTimeoutMilliseconds
public void resetTimeoutMilliseconds()
resetTlsConfig
public void resetTlsConfig()
resetUri
public void resetUri()

Static Functions

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

isConstruct
import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegration;

ApiGatewayIntegration.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.api_gateway_integration.ApiGatewayIntegration;

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

isTerraformResource
import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegration;

ApiGatewayIntegration.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegration;

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

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing ApiGatewayIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#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 ApiGatewayIntegration to import is found.


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
tlsConfig ApiGatewayIntegrationTlsConfigOutputReference No description.
cacheKeyParametersInput java.util.List<java.lang.String> No description.
cacheNamespaceInput java.lang.String No description.
connectionIdInput java.lang.String No description.
connectionTypeInput java.lang.String No description.
contentHandlingInput java.lang.String No description.
credentialsInput java.lang.String No description.
httpMethodInput java.lang.String No description.
idInput java.lang.String No description.
integrationHttpMethodInput java.lang.String No description.
passthroughBehaviorInput java.lang.String No description.
requestParametersInput java.util.Map<java.lang.String, java.lang.String> No description.
requestTemplatesInput java.util.Map<java.lang.String, java.lang.String> No description.
resourceIdInput java.lang.String No description.
restApiIdInput java.lang.String No description.
timeoutMillisecondsInput java.lang.Number No description.
tlsConfigInput ApiGatewayIntegrationTlsConfig No description.
typeInput java.lang.String No description.
uriInput java.lang.String No description.
cacheKeyParameters java.util.List<java.lang.String> No description.
cacheNamespace java.lang.String No description.
connectionId java.lang.String No description.
connectionType java.lang.String No description.
contentHandling java.lang.String No description.
credentials java.lang.String No description.
httpMethod java.lang.String No description.
id java.lang.String No description.
integrationHttpMethod java.lang.String No description.
passthroughBehavior java.lang.String No description.
requestParameters java.util.Map<java.lang.String, java.lang.String> No description.
requestTemplates java.util.Map<java.lang.String, java.lang.String> No description.
resourceId java.lang.String No description.
restApiId java.lang.String No description.
timeoutMilliseconds java.lang.Number No description.
type java.lang.String No description.
uri java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

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

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

tlsConfigRequired
public ApiGatewayIntegrationTlsConfigOutputReference getTlsConfig();

cacheKeyParametersInputOptional
public java.util.List<java.lang.String> getCacheKeyParametersInput();
  • Type: java.util.List<java.lang.String>

cacheNamespaceInputOptional
public java.lang.String getCacheNamespaceInput();
  • Type: java.lang.String

connectionIdInputOptional
public java.lang.String getConnectionIdInput();
  • Type: java.lang.String

connectionTypeInputOptional
public java.lang.String getConnectionTypeInput();
  • Type: java.lang.String

contentHandlingInputOptional
public java.lang.String getContentHandlingInput();
  • Type: java.lang.String

credentialsInputOptional
public java.lang.String getCredentialsInput();
  • Type: java.lang.String

httpMethodInputOptional
public java.lang.String getHttpMethodInput();
  • Type: java.lang.String

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

integrationHttpMethodInputOptional
public java.lang.String getIntegrationHttpMethodInput();
  • Type: java.lang.String

passthroughBehaviorInputOptional
public java.lang.String getPassthroughBehaviorInput();
  • Type: java.lang.String

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

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

resourceIdInputOptional
public java.lang.String getResourceIdInput();
  • Type: java.lang.String

restApiIdInputOptional
public java.lang.String getRestApiIdInput();
  • Type: java.lang.String

timeoutMillisecondsInputOptional
public java.lang.Number getTimeoutMillisecondsInput();
  • Type: java.lang.Number

tlsConfigInputOptional
public ApiGatewayIntegrationTlsConfig getTlsConfigInput();

typeInputOptional
public java.lang.String getTypeInput();
  • Type: java.lang.String

uriInputOptional
public java.lang.String getUriInput();
  • Type: java.lang.String

cacheKeyParametersRequired
public java.util.List<java.lang.String> getCacheKeyParameters();
  • Type: java.util.List<java.lang.String>

cacheNamespaceRequired
public java.lang.String getCacheNamespace();
  • Type: java.lang.String

connectionIdRequired
public java.lang.String getConnectionId();
  • Type: java.lang.String

connectionTypeRequired
public java.lang.String getConnectionType();
  • Type: java.lang.String

contentHandlingRequired
public java.lang.String getContentHandling();
  • Type: java.lang.String

credentialsRequired
public java.lang.String getCredentials();
  • Type: java.lang.String

httpMethodRequired
public java.lang.String getHttpMethod();
  • Type: java.lang.String

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

integrationHttpMethodRequired
public java.lang.String getIntegrationHttpMethod();
  • Type: java.lang.String

passthroughBehaviorRequired
public java.lang.String getPassthroughBehavior();
  • Type: java.lang.String

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

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

resourceIdRequired
public java.lang.String getResourceId();
  • Type: java.lang.String

restApiIdRequired
public java.lang.String getRestApiId();
  • Type: java.lang.String

timeoutMillisecondsRequired
public java.lang.Number getTimeoutMilliseconds();
  • Type: java.lang.Number

typeRequired
public java.lang.String getType();
  • Type: java.lang.String

uriRequired
public java.lang.String getUri();
  • 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

ApiGatewayIntegrationConfig

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegrationConfig;

ApiGatewayIntegrationConfig.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>)
    .httpMethod(java.lang.String)
    .resourceId(java.lang.String)
    .restApiId(java.lang.String)
    .type(java.lang.String)
//  .cacheKeyParameters(java.util.List<java.lang.String>)
//  .cacheNamespace(java.lang.String)
//  .connectionId(java.lang.String)
//  .connectionType(java.lang.String)
//  .contentHandling(java.lang.String)
//  .credentials(java.lang.String)
//  .id(java.lang.String)
//  .integrationHttpMethod(java.lang.String)
//  .passthroughBehavior(java.lang.String)
//  .requestParameters(java.util.Map<java.lang.String, java.lang.String>)
//  .requestTemplates(java.util.Map<java.lang.String, java.lang.String>)
//  .timeoutMilliseconds(java.lang.Number)
//  .tlsConfig(ApiGatewayIntegrationTlsConfig)
//  .uri(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
httpMethod java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.
resourceId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.
restApiId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.
type java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.
cacheKeyParameters java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.
cacheNamespace java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.
connectionId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.
connectionType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.
contentHandling java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.
credentials java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#id}.
integrationHttpMethod java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.
passthroughBehavior java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.
requestParameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.
requestTemplates java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.
timeoutMilliseconds java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.
tlsConfig ApiGatewayIntegrationTlsConfig tls_config block.
uri java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

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>

httpMethodRequired
public java.lang.String getHttpMethod();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.


resourceIdRequired
public java.lang.String getResourceId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.


restApiIdRequired
public java.lang.String getRestApiId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.


typeRequired
public java.lang.String getType();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.


cacheKeyParametersOptional
public java.util.List<java.lang.String> getCacheKeyParameters();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.


cacheNamespaceOptional
public java.lang.String getCacheNamespace();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.


connectionIdOptional
public java.lang.String getConnectionId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.


connectionTypeOptional
public java.lang.String getConnectionType();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.


contentHandlingOptional
public java.lang.String getContentHandling();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.


credentialsOptional
public java.lang.String getCredentials();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#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.


integrationHttpMethodOptional
public java.lang.String getIntegrationHttpMethod();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.


passthroughBehaviorOptional
public java.lang.String getPassthroughBehavior();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.


timeoutMillisecondsOptional
public java.lang.Number getTimeoutMilliseconds();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.


tlsConfigOptional
public ApiGatewayIntegrationTlsConfig getTlsConfig();

tls_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#tls_config ApiGatewayIntegration#tls_config}


uriOptional
public java.lang.String getUri();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.


ApiGatewayIntegrationTlsConfig

Initializer

import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegrationTlsConfig;

ApiGatewayIntegrationTlsConfig.builder()
//  .insecureSkipVerification(java.lang.Boolean)
//  .insecureSkipVerification(IResolvable)
    .build();

Properties

Name Type Description
insecureSkipVerification java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#insecure_skip_verification ApiGatewayIntegration#insecure_skip_verification}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/api_gateway_integration#insecure_skip_verification ApiGatewayIntegration#insecure_skip_verification}.


Classes

ApiGatewayIntegrationTlsConfigOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.api_gateway_integration.ApiGatewayIntegrationTlsConfigOutputReference;

new ApiGatewayIntegrationTlsConfigOutputReference(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.
resetInsecureSkipVerification 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.

resetInsecureSkipVerification
public void resetInsecureSkipVerification()

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.
insecureSkipVerificationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
insecureSkipVerification java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
internalValue ApiGatewayIntegrationTlsConfig 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

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

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

internalValueOptional
public ApiGatewayIntegrationTlsConfig getInternalValue();