Skip to content

Latest commit

 

History

History
2706 lines (1682 loc) · 124 KB

apigatewayv2Stage.md

File metadata and controls

2706 lines (1682 loc) · 124 KB

aws_apigatewayv2_stage

Refer to the Terraform Registory for docs: aws_apigatewayv2_stage.

apigatewayv2Stage Submodule

Constructs

Apigatewayv2Stage

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

Initializers 

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

new apigatewayv2Stage.Apigatewayv2Stage(scope: Construct, id: string, config: Apigatewayv2StageConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config Apigatewayv2StageConfig 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.
putAccessLogSettings No description.
putDefaultRouteSettings No description.
putRouteSettings No description.
resetAccessLogSettings No description.
resetAutoDeploy No description.
resetClientCertificateId No description.
resetDefaultRouteSettings No description.
resetDeploymentId No description.
resetDescription No description.
resetId No description.
resetRouteSettings No description.
resetStageVariables No description.
resetTags No description.
resetTagsAll 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
putAccessLogSettings 
public putAccessLogSettings(value: Apigatewayv2StageAccessLogSettings): void
valueRequired
putDefaultRouteSettings 
public putDefaultRouteSettings(value: Apigatewayv2StageDefaultRouteSettings): void
valueRequired
putRouteSettings 
public putRouteSettings(value: IResolvable | Apigatewayv2StageRouteSettings[]): void
valueRequired
resetAccessLogSettings 
public resetAccessLogSettings(): void
resetAutoDeploy 
public resetAutoDeploy(): void
resetClientCertificateId 
public resetClientCertificateId(): void
resetDefaultRouteSettings 
public resetDefaultRouteSettings(): void
resetDeploymentId 
public resetDeploymentId(): void
resetDescription 
public resetDescription(): void
resetId 
public resetId(): void
resetRouteSettings 
public resetRouteSettings(): void
resetStageVariables 
public resetStageVariables(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

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

apigatewayv2Stage.Apigatewayv2Stage.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 { apigatewayv2Stage } from '@cdktf/aws-cdk'

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

apigatewayv2Stage.Apigatewayv2Stage.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.
accessLogSettings Apigatewayv2StageAccessLogSettingsOutputReference No description.
arn string No description.
defaultRouteSettings Apigatewayv2StageDefaultRouteSettingsOutputReference No description.
executionArn string No description.
invokeUrl string No description.
routeSettings Apigatewayv2StageRouteSettingsList No description.
accessLogSettingsInput Apigatewayv2StageAccessLogSettings No description.
apiIdInput string No description.
autoDeployInput boolean | cdktf.IResolvable No description.
clientCertificateIdInput string No description.
defaultRouteSettingsInput Apigatewayv2StageDefaultRouteSettings No description.
deploymentIdInput string No description.
descriptionInput string No description.
idInput string No description.
nameInput string No description.
routeSettingsInput cdktf.IResolvable | Apigatewayv2StageRouteSettings[] No description.
stageVariablesInput {[ key: string ]: string} No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
apiId string No description.
autoDeploy boolean | cdktf.IResolvable No description.
clientCertificateId string No description.
deploymentId string No description.
description string No description.
id string No description.
name string No description.
stageVariables {[ key: string ]: string} No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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[]
accessLogSettingsRequired 
public readonly accessLogSettings: Apigatewayv2StageAccessLogSettingsOutputReference;
arnRequired 
public readonly arn: string;
  • Type: string
defaultRouteSettingsRequired 
public readonly defaultRouteSettings: Apigatewayv2StageDefaultRouteSettingsOutputReference;
executionArnRequired 
public readonly executionArn: string;
  • Type: string
invokeUrlRequired 
public readonly invokeUrl: string;
  • Type: string
routeSettingsRequired 
public readonly routeSettings: Apigatewayv2StageRouteSettingsList;
accessLogSettingsInputOptional 
public readonly accessLogSettingsInput: Apigatewayv2StageAccessLogSettings;
apiIdInputOptional 
public readonly apiIdInput: string;
  • Type: string
autoDeployInputOptional 
public readonly autoDeployInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
clientCertificateIdInputOptional 
public readonly clientCertificateIdInput: string;
  • Type: string
defaultRouteSettingsInputOptional 
public readonly defaultRouteSettingsInput: Apigatewayv2StageDefaultRouteSettings;
deploymentIdInputOptional 
public readonly deploymentIdInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
routeSettingsInputOptional 
public readonly routeSettingsInput: IResolvable | Apigatewayv2StageRouteSettings[];
stageVariablesInputOptional 
public readonly stageVariablesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
apiIdRequired 
public readonly apiId: string;
  • Type: string
autoDeployRequired 
public readonly autoDeploy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
clientCertificateIdRequired 
public readonly clientCertificateId: string;
  • Type: string
deploymentIdRequired 
public readonly deploymentId: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
stageVariablesRequired 
public readonly stageVariables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

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

Structs

Apigatewayv2StageAccessLogSettings

Initializer 

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

const apigatewayv2StageAccessLogSettings: apigatewayv2Stage.Apigatewayv2StageAccessLogSettings = { ... }

Properties

Name Type Description
destinationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#destination_arn Apigatewayv2Stage#destination_arn}.
format string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#format Apigatewayv2Stage#format}.
destinationArnRequired 
public readonly destinationArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#destination_arn Apigatewayv2Stage#destination_arn}.

formatRequired 
public readonly format: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#format Apigatewayv2Stage#format}.

Apigatewayv2StageConfig

Initializer 

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

const apigatewayv2StageConfig: apigatewayv2Stage.Apigatewayv2StageConfig = { ... }

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.
apiId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#api_id Apigatewayv2Stage#api_id}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#name Apigatewayv2Stage#name}.
accessLogSettings Apigatewayv2StageAccessLogSettings access_log_settings block.
autoDeploy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#auto_deploy Apigatewayv2Stage#auto_deploy}.
clientCertificateId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#client_certificate_id Apigatewayv2Stage#client_certificate_id}.
defaultRouteSettings Apigatewayv2StageDefaultRouteSettings default_route_settings block.
deploymentId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#deployment_id Apigatewayv2Stage#deployment_id}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#description Apigatewayv2Stage#description}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#id Apigatewayv2Stage#id}.
routeSettings cdktf.IResolvable | Apigatewayv2StageRouteSettings[] route_settings block.
stageVariables {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#stage_variables Apigatewayv2Stage#stage_variables}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#tags Apigatewayv2Stage#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#tags_all Apigatewayv2Stage#tags_all}.
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[]
apiIdRequired 
public readonly apiId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#api_id Apigatewayv2Stage#api_id}.

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_stage#name Apigatewayv2Stage#name}.

accessLogSettingsOptional 
public readonly accessLogSettings: Apigatewayv2StageAccessLogSettings;

access_log_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#access_log_settings Apigatewayv2Stage#access_log_settings}

autoDeployOptional 
public readonly autoDeploy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#auto_deploy Apigatewayv2Stage#auto_deploy}.

clientCertificateIdOptional 
public readonly clientCertificateId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#client_certificate_id Apigatewayv2Stage#client_certificate_id}.

defaultRouteSettingsOptional 
public readonly defaultRouteSettings: Apigatewayv2StageDefaultRouteSettings;

default_route_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#default_route_settings Apigatewayv2Stage#default_route_settings}

deploymentIdOptional 
public readonly deploymentId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#deployment_id Apigatewayv2Stage#deployment_id}.

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_stage#description Apigatewayv2Stage#description}.

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_stage#id Apigatewayv2Stage#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.

routeSettingsOptional 
public readonly routeSettings: IResolvable | Apigatewayv2StageRouteSettings[];

route_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#route_settings Apigatewayv2Stage#route_settings}

stageVariablesOptional 
public readonly stageVariables: {[ 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_stage#stage_variables Apigatewayv2Stage#stage_variables}.

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_stage#tags Apigatewayv2Stage#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_stage#tags_all Apigatewayv2Stage#tags_all}.

Apigatewayv2StageDefaultRouteSettings

Initializer 

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

const apigatewayv2StageDefaultRouteSettings: apigatewayv2Stage.Apigatewayv2StageDefaultRouteSettings = { ... }

Properties

Name Type Description
dataTraceEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#data_trace_enabled Apigatewayv2Stage#data_trace_enabled}.
detailedMetricsEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#detailed_metrics_enabled Apigatewayv2Stage#detailed_metrics_enabled}.
loggingLevel string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#logging_level Apigatewayv2Stage#logging_level}.
throttlingBurstLimit number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_burst_limit Apigatewayv2Stage#throttling_burst_limit}.
throttlingRateLimit number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_rate_limit Apigatewayv2Stage#throttling_rate_limit}.
dataTraceEnabledOptional 
public readonly dataTraceEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#data_trace_enabled Apigatewayv2Stage#data_trace_enabled}.

detailedMetricsEnabledOptional 
public readonly detailedMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#detailed_metrics_enabled Apigatewayv2Stage#detailed_metrics_enabled}.

loggingLevelOptional 
public readonly loggingLevel: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#logging_level Apigatewayv2Stage#logging_level}.

throttlingBurstLimitOptional 
public readonly throttlingBurstLimit: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_burst_limit Apigatewayv2Stage#throttling_burst_limit}.

throttlingRateLimitOptional 
public readonly throttlingRateLimit: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_rate_limit Apigatewayv2Stage#throttling_rate_limit}.

Apigatewayv2StageRouteSettings

Initializer 

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

const apigatewayv2StageRouteSettings: apigatewayv2Stage.Apigatewayv2StageRouteSettings = { ... }

Properties

Name Type Description
routeKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#route_key Apigatewayv2Stage#route_key}.
dataTraceEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#data_trace_enabled Apigatewayv2Stage#data_trace_enabled}.
detailedMetricsEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#detailed_metrics_enabled Apigatewayv2Stage#detailed_metrics_enabled}.
loggingLevel string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#logging_level Apigatewayv2Stage#logging_level}.
throttlingBurstLimit number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_burst_limit Apigatewayv2Stage#throttling_burst_limit}.
throttlingRateLimit number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_rate_limit Apigatewayv2Stage#throttling_rate_limit}.
routeKeyRequired 
public readonly routeKey: string;
  • Type: string

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

dataTraceEnabledOptional 
public readonly dataTraceEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#data_trace_enabled Apigatewayv2Stage#data_trace_enabled}.

detailedMetricsEnabledOptional 
public readonly detailedMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#detailed_metrics_enabled Apigatewayv2Stage#detailed_metrics_enabled}.

loggingLevelOptional 
public readonly loggingLevel: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#logging_level Apigatewayv2Stage#logging_level}.

throttlingBurstLimitOptional 
public readonly throttlingBurstLimit: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_burst_limit Apigatewayv2Stage#throttling_burst_limit}.

throttlingRateLimitOptional 
public readonly throttlingRateLimit: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_stage#throttling_rate_limit Apigatewayv2Stage#throttling_rate_limit}.

Classes

Apigatewayv2StageAccessLogSettingsOutputReference

Initializers 

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

new apigatewayv2Stage.Apigatewayv2StageAccessLogSettingsOutputReference(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.
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.

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.
destinationArnInput string No description.
formatInput string No description.
destinationArn string No description.
format string No description.
internalValue Apigatewayv2StageAccessLogSettings 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
destinationArnInputOptional 
public readonly destinationArnInput: string;
  • Type: string
formatInputOptional 
public readonly formatInput: string;
  • Type: string
destinationArnRequired 
public readonly destinationArn: string;
  • Type: string
formatRequired 
public readonly format: string;
  • Type: string
internalValueOptional 
public readonly internalValue: Apigatewayv2StageAccessLogSettings;

Apigatewayv2StageDefaultRouteSettingsOutputReference

Initializers 

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

new apigatewayv2Stage.Apigatewayv2StageDefaultRouteSettingsOutputReference(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.
resetDataTraceEnabled No description.
resetDetailedMetricsEnabled No description.
resetLoggingLevel No description.
resetThrottlingBurstLimit No description.
resetThrottlingRateLimit 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.

resetDataTraceEnabled 
public resetDataTraceEnabled(): void
resetDetailedMetricsEnabled 
public resetDetailedMetricsEnabled(): void
resetLoggingLevel 
public resetLoggingLevel(): void
resetThrottlingBurstLimit 
public resetThrottlingBurstLimit(): void
resetThrottlingRateLimit 
public resetThrottlingRateLimit(): 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.
dataTraceEnabledInput boolean | cdktf.IResolvable No description.
detailedMetricsEnabledInput boolean | cdktf.IResolvable No description.
loggingLevelInput string No description.
throttlingBurstLimitInput number No description.
throttlingRateLimitInput number No description.
dataTraceEnabled boolean | cdktf.IResolvable No description.
detailedMetricsEnabled boolean | cdktf.IResolvable No description.
loggingLevel string No description.
throttlingBurstLimit number No description.
throttlingRateLimit number No description.
internalValue Apigatewayv2StageDefaultRouteSettings 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
dataTraceEnabledInputOptional 
public readonly dataTraceEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
detailedMetricsEnabledInputOptional 
public readonly detailedMetricsEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loggingLevelInputOptional 
public readonly loggingLevelInput: string;
  • Type: string
throttlingBurstLimitInputOptional 
public readonly throttlingBurstLimitInput: number;
  • Type: number
throttlingRateLimitInputOptional 
public readonly throttlingRateLimitInput: number;
  • Type: number
dataTraceEnabledRequired 
public readonly dataTraceEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
detailedMetricsEnabledRequired 
public readonly detailedMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loggingLevelRequired 
public readonly loggingLevel: string;
  • Type: string
throttlingBurstLimitRequired 
public readonly throttlingBurstLimit: number;
  • Type: number
throttlingRateLimitRequired 
public readonly throttlingRateLimit: number;
  • Type: number
internalValueOptional 
public readonly internalValue: Apigatewayv2StageDefaultRouteSettings;

Apigatewayv2StageRouteSettingsList

Initializers 

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

new apigatewayv2Stage.Apigatewayv2StageRouteSettingsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
computeFqn 
public computeFqn(): 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.

get 
public get(index: number): Apigatewayv2StageRouteSettingsOutputReference
indexRequired
  • Type: number

the index of the item to return.

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.
internalValue cdktf.IResolvable | Apigatewayv2StageRouteSettings[] 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
internalValueOptional 
public readonly internalValue: IResolvable | Apigatewayv2StageRouteSettings[];

Apigatewayv2StageRouteSettingsOutputReference

Initializers 

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

new apigatewayv2Stage.Apigatewayv2StageRouteSettingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDataTraceEnabled No description.
resetDetailedMetricsEnabled No description.
resetLoggingLevel No description.
resetThrottlingBurstLimit No description.
resetThrottlingRateLimit 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.

resetDataTraceEnabled 
public resetDataTraceEnabled(): void
resetDetailedMetricsEnabled 
public resetDetailedMetricsEnabled(): void
resetLoggingLevel 
public resetLoggingLevel(): void
resetThrottlingBurstLimit 
public resetThrottlingBurstLimit(): void
resetThrottlingRateLimit 
public resetThrottlingRateLimit(): 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.
dataTraceEnabledInput boolean | cdktf.IResolvable No description.
detailedMetricsEnabledInput boolean | cdktf.IResolvable No description.
loggingLevelInput string No description.
routeKeyInput string No description.
throttlingBurstLimitInput number No description.
throttlingRateLimitInput number No description.
dataTraceEnabled boolean | cdktf.IResolvable No description.
detailedMetricsEnabled boolean | cdktf.IResolvable No description.
loggingLevel string No description.
routeKey string No description.
throttlingBurstLimit number No description.
throttlingRateLimit number No description.
internalValue cdktf.IResolvable | Apigatewayv2StageRouteSettings 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
dataTraceEnabledInputOptional 
public readonly dataTraceEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
detailedMetricsEnabledInputOptional 
public readonly detailedMetricsEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loggingLevelInputOptional 
public readonly loggingLevelInput: string;
  • Type: string
routeKeyInputOptional 
public readonly routeKeyInput: string;
  • Type: string
throttlingBurstLimitInputOptional 
public readonly throttlingBurstLimitInput: number;
  • Type: number
throttlingRateLimitInputOptional 
public readonly throttlingRateLimitInput: number;
  • Type: number
dataTraceEnabledRequired 
public readonly dataTraceEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
detailedMetricsEnabledRequired 
public readonly detailedMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
loggingLevelRequired 
public readonly loggingLevel: string;
  • Type: string
routeKeyRequired 
public readonly routeKey: string;
  • Type: string
throttlingBurstLimitRequired 
public readonly throttlingBurstLimit: number;
  • Type: number
throttlingRateLimitRequired 
public readonly throttlingRateLimit: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | Apigatewayv2StageRouteSettings;