Skip to content

Latest commit

 

History

History
1836 lines (1154 loc) · 78.8 KB

apigatewayv2Api.md

File metadata and controls

1836 lines (1154 loc) · 78.8 KB

aws_apigatewayv2_api

Refer to the Terraform Registory for docs: aws_apigatewayv2_api.

apigatewayv2Api Submodule

Constructs

Apigatewayv2Api

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api aws_apigatewayv2_api}.

Initializers 

import { apigatewayv2Api } from '@cdktf/aws-cdk'

new apigatewayv2Api.Apigatewayv2Api(scope: Construct, id: string, config: Apigatewayv2ApiConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config Apigatewayv2ApiConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
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.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putCorsConfiguration 
public putCorsConfiguration(value: Apigatewayv2ApiCorsConfiguration): void
valueRequired
resetApiKeySelectionExpression 
public resetApiKeySelectionExpression(): void
resetBody 
public resetBody(): void
resetCorsConfiguration 
public resetCorsConfiguration(): void
resetCredentialsArn 
public resetCredentialsArn(): void
resetDescription 
public resetDescription(): void
resetDisableExecuteApiEndpoint 
public resetDisableExecuteApiEndpoint(): void
resetFailOnWarnings 
public resetFailOnWarnings(): void
resetId 
public resetId(): void
resetRouteKey 
public resetRouteKey(): void
resetRouteSelectionExpression 
public resetRouteSelectionExpression(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTarget 
public resetTarget(): void
resetVersion 
public resetVersion(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { apigatewayv2Api } from '@cdktf/aws-cdk'

apigatewayv2Api.Apigatewayv2Api.isConstruct(x: any)

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: any

Any object.

isTerraformElement 
import { apigatewayv2Api } from '@cdktf/aws-cdk'

apigatewayv2Api.Apigatewayv2Api.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { apigatewayv2Api } from '@cdktf/aws-cdk'

apigatewayv2Api.Apigatewayv2Api.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
apiEndpoint string No description.
arn string No description.
corsConfiguration Apigatewayv2ApiCorsConfigurationOutputReference No description.
executionArn string No description.
apiKeySelectionExpressionInput string No description.
bodyInput string No description.
corsConfigurationInput Apigatewayv2ApiCorsConfiguration No description.
credentialsArnInput string No description.
descriptionInput string No description.
disableExecuteApiEndpointInput boolean | cdktf.IResolvable No description.
failOnWarningsInput boolean | cdktf.IResolvable No description.
idInput string No description.
nameInput string No description.
protocolTypeInput string No description.
routeKeyInput string No description.
routeSelectionExpressionInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
targetInput string No description.
versionInput string No description.
apiKeySelectionExpression string No description.
body string No description.
credentialsArn string No description.
description string No description.
disableExecuteApiEndpoint boolean | cdktf.IResolvable No description.
failOnWarnings boolean | cdktf.IResolvable No description.
id string No description.
name string No description.
protocolType string No description.
routeKey string No description.
routeSelectionExpression string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
target string No description.
version string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
apiEndpointRequired 
public readonly apiEndpoint: string;
  • Type: string
arnRequired 
public readonly arn: string;
  • Type: string
corsConfigurationRequired 
public readonly corsConfiguration: Apigatewayv2ApiCorsConfigurationOutputReference;
executionArnRequired 
public readonly executionArn: string;
  • Type: string
apiKeySelectionExpressionInputOptional 
public readonly apiKeySelectionExpressionInput: string;
  • Type: string
bodyInputOptional 
public readonly bodyInput: string;
  • Type: string
corsConfigurationInputOptional 
public readonly corsConfigurationInput: Apigatewayv2ApiCorsConfiguration;
credentialsArnInputOptional 
public readonly credentialsArnInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
disableExecuteApiEndpointInputOptional 
public readonly disableExecuteApiEndpointInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
failOnWarningsInputOptional 
public readonly failOnWarningsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
protocolTypeInputOptional 
public readonly protocolTypeInput: string;
  • Type: string
routeKeyInputOptional 
public readonly routeKeyInput: string;
  • Type: string
routeSelectionExpressionInputOptional 
public readonly routeSelectionExpressionInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
targetInputOptional 
public readonly targetInput: string;
  • Type: string
versionInputOptional 
public readonly versionInput: string;
  • Type: string
apiKeySelectionExpressionRequired 
public readonly apiKeySelectionExpression: string;
  • Type: string
bodyRequired 
public readonly body: string;
  • Type: string
credentialsArnRequired 
public readonly credentialsArn: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
disableExecuteApiEndpointRequired 
public readonly disableExecuteApiEndpoint: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
failOnWarningsRequired 
public readonly failOnWarnings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
protocolTypeRequired 
public readonly protocolType: string;
  • Type: string
routeKeyRequired 
public readonly routeKey: string;
  • Type: string
routeSelectionExpressionRequired 
public readonly routeSelectionExpression: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
targetRequired 
public readonly target: string;
  • Type: string
versionRequired 
public readonly version: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

Apigatewayv2ApiConfig

Initializer 

import { apigatewayv2Api } from '@cdktf/aws-cdk'

const apigatewayv2ApiConfig: apigatewayv2Api.Apigatewayv2ApiConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
protocolType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
apiKeySelectionExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
body string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
corsConfiguration Apigatewayv2ApiCorsConfiguration cors_configuration block.
credentialsArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
disableExecuteApiEndpoint boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
failOnWarnings boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.
routeKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
routeSelectionExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
target string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
version string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.

protocolTypeRequired 
public readonly protocolType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.

apiKeySelectionExpressionOptional 
public readonly apiKeySelectionExpression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.

bodyOptional 
public readonly body: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.

corsConfigurationOptional 
public readonly corsConfiguration: Apigatewayv2ApiCorsConfiguration;

cors_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}

credentialsArnOptional 
public readonly credentialsArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.

disableExecuteApiEndpointOptional 
public readonly disableExecuteApiEndpoint: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.

failOnWarningsOptional 
public readonly failOnWarnings: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/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.

routeKeyOptional 
public readonly routeKey: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.

routeSelectionExpressionOptional 
public readonly routeSelectionExpression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.

targetOptional 
public readonly target: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.

versionOptional 
public readonly version: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

Apigatewayv2ApiCorsConfiguration

Initializer 

import { apigatewayv2Api } from '@cdktf/aws-cdk'

const apigatewayv2ApiCorsConfiguration: apigatewayv2Api.Apigatewayv2ApiCorsConfiguration = { ... }

Properties

Name Type Description
allowCredentials boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.
allowHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.
allowMethods string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.
allowOrigins string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.
exposeHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.
maxAge number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.
allowCredentialsOptional 
public readonly allowCredentials: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.

allowHeadersOptional 
public readonly allowHeaders: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.

allowMethodsOptional 
public readonly allowMethods: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.

allowOriginsOptional 
public readonly allowOrigins: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.

exposeHeadersOptional 
public readonly exposeHeaders: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.

maxAgeOptional 
public readonly maxAge: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

Classes

Apigatewayv2ApiCorsConfigurationOutputReference

Initializers 

import { apigatewayv2Api } from '@cdktf/aws-cdk'

new apigatewayv2Api.Apigatewayv2ApiCorsConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: 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.
resetAllowCredentials No description.
resetAllowHeaders No description.
resetAllowMethods No description.
resetAllowOrigins No description.
resetExposeHeaders No description.
resetMaxAge No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowCredentials 
public resetAllowCredentials(): void
resetAllowHeaders 
public resetAllowHeaders(): void
resetAllowMethods 
public resetAllowMethods(): void
resetAllowOrigins 
public resetAllowOrigins(): void
resetExposeHeaders 
public resetExposeHeaders(): void
resetMaxAge 
public resetMaxAge(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
allowCredentialsInput boolean | cdktf.IResolvable No description.
allowHeadersInput string[] No description.
allowMethodsInput string[] No description.
allowOriginsInput string[] No description.
exposeHeadersInput string[] No description.
maxAgeInput number No description.
allowCredentials boolean | cdktf.IResolvable No description.
allowHeaders string[] No description.
allowMethods string[] No description.
allowOrigins string[] No description.
exposeHeaders string[] No description.
maxAge number No description.
internalValue Apigatewayv2ApiCorsConfiguration No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: 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 readonly fqn: string;
  • Type: string
allowCredentialsInputOptional 
public readonly allowCredentialsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
allowHeadersInputOptional 
public readonly allowHeadersInput: string[];
  • Type: string[]
allowMethodsInputOptional 
public readonly allowMethodsInput: string[];
  • Type: string[]
allowOriginsInputOptional 
public readonly allowOriginsInput: string[];
  • Type: string[]
exposeHeadersInputOptional 
public readonly exposeHeadersInput: string[];
  • Type: string[]
maxAgeInputOptional 
public readonly maxAgeInput: number;
  • Type: number
allowCredentialsRequired 
public readonly allowCredentials: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
allowHeadersRequired 
public readonly allowHeaders: string[];
  • Type: string[]
allowMethodsRequired 
public readonly allowMethods: string[];
  • Type: string[]
allowOriginsRequired 
public readonly allowOrigins: string[];
  • Type: string[]
exposeHeadersRequired 
public readonly exposeHeaders: string[];
  • Type: string[]
maxAgeRequired 
public readonly maxAge: number;
  • Type: number
internalValueOptional 
public readonly internalValue: Apigatewayv2ApiCorsConfiguration;