Skip to content

Latest commit

 

History

History
1574 lines (984 loc) · 66.8 KB

apiGatewayStage.md

File metadata and controls

1574 lines (984 loc) · 66.8 KB

aws_api_gateway_stage

Refer to the Terraform Registory for docs: aws_api_gateway_stage.

apiGatewayStage Submodule

Constructs

ApiGatewayStage

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

Initializers 

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

new apiGatewayStage.ApiGatewayStage(scope: Construct, id: string, config: ApiGatewayStageConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ApiGatewayStageConfig 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.
resetAccessLogSettings No description.
resetCacheClusterEnabled No description.
resetCacheClusterSize No description.
resetClientCertificateId No description.
resetDescription No description.
resetDocumentationVersion No description.
resetId No description.
resetTags No description.
resetTagsAll No description.
resetVariables No description.
resetXrayTracingEnabled 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: ApiGatewayStageAccessLogSettings): void
valueRequired
resetAccessLogSettings 
public resetAccessLogSettings(): void
resetCacheClusterEnabled 
public resetCacheClusterEnabled(): void
resetCacheClusterSize 
public resetCacheClusterSize(): void
resetClientCertificateId 
public resetClientCertificateId(): void
resetDescription 
public resetDescription(): void
resetDocumentationVersion 
public resetDocumentationVersion(): void
resetId 
public resetId(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetVariables 
public resetVariables(): void
resetXrayTracingEnabled 
public resetXrayTracingEnabled(): void

Static Functions

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

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

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

apiGatewayStage.ApiGatewayStage.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 ApiGatewayStageAccessLogSettingsOutputReference No description.
arn string No description.
executionArn string No description.
invokeUrl string No description.
webAclArn string No description.
accessLogSettingsInput ApiGatewayStageAccessLogSettings No description.
cacheClusterEnabledInput boolean | cdktf.IResolvable No description.
cacheClusterSizeInput string No description.
clientCertificateIdInput string No description.
deploymentIdInput string No description.
descriptionInput string No description.
documentationVersionInput string No description.
idInput string No description.
restApiIdInput string No description.
stageNameInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
variablesInput {[ key: string ]: string} No description.
xrayTracingEnabledInput boolean | cdktf.IResolvable No description.
cacheClusterEnabled boolean | cdktf.IResolvable No description.
cacheClusterSize string No description.
clientCertificateId string No description.
deploymentId string No description.
description string No description.
documentationVersion string No description.
id string No description.
restApiId string No description.
stageName string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
variables {[ key: string ]: string} No description.
xrayTracingEnabled boolean | cdktf.IResolvable 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: ApiGatewayStageAccessLogSettingsOutputReference;
arnRequired 
public readonly arn: string;
  • Type: string
executionArnRequired 
public readonly executionArn: string;
  • Type: string
invokeUrlRequired 
public readonly invokeUrl: string;
  • Type: string
webAclArnRequired 
public readonly webAclArn: string;
  • Type: string
accessLogSettingsInputOptional 
public readonly accessLogSettingsInput: ApiGatewayStageAccessLogSettings;
cacheClusterEnabledInputOptional 
public readonly cacheClusterEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
cacheClusterSizeInputOptional 
public readonly cacheClusterSizeInput: string;
  • Type: string
clientCertificateIdInputOptional 
public readonly clientCertificateIdInput: string;
  • Type: string
deploymentIdInputOptional 
public readonly deploymentIdInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
documentationVersionInputOptional 
public readonly documentationVersionInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
restApiIdInputOptional 
public readonly restApiIdInput: string;
  • Type: string
stageNameInputOptional 
public readonly stageNameInput: 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}
variablesInputOptional 
public readonly variablesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
xrayTracingEnabledInputOptional 
public readonly xrayTracingEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
cacheClusterEnabledRequired 
public readonly cacheClusterEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
cacheClusterSizeRequired 
public readonly cacheClusterSize: string;
  • Type: string
clientCertificateIdRequired 
public readonly clientCertificateId: string;
  • Type: string
deploymentIdRequired 
public readonly deploymentId: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
documentationVersionRequired 
public readonly documentationVersion: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
restApiIdRequired 
public readonly restApiId: string;
  • Type: string
stageNameRequired 
public readonly stageName: 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}
variablesRequired 
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
xrayTracingEnabledRequired 
public readonly xrayTracingEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

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

Structs

ApiGatewayStageAccessLogSettings

Initializer 

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

const apiGatewayStageAccessLogSettings: apiGatewayStage.ApiGatewayStageAccessLogSettings = { ... }

Properties

Name Type Description
destinationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#destination_arn ApiGatewayStage#destination_arn}.
format string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#format ApiGatewayStage#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/api_gateway_stage#destination_arn ApiGatewayStage#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/api_gateway_stage#format ApiGatewayStage#format}.

ApiGatewayStageConfig

Initializer 

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

const apiGatewayStageConfig: apiGatewayStage.ApiGatewayStageConfig = { ... }

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.
deploymentId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
restApiId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.
stageName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.
accessLogSettings ApiGatewayStageAccessLogSettings access_log_settings block.
cacheClusterEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.
cacheClusterSize string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.
clientCertificateId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_id}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.
documentationVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#id ApiGatewayStage#id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.
variables {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.
xrayTracingEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.
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[]
deploymentIdRequired 
public readonly deploymentId: string;
  • Type: string

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

restApiIdRequired 
public readonly restApiId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#rest_api_id ApiGatewayStage#rest_api_id}.

stageNameRequired 
public readonly stageName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.

accessLogSettingsOptional 
public readonly accessLogSettings: ApiGatewayStageAccessLogSettings;

access_log_settings block.

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

cacheClusterEnabledOptional 
public readonly cacheClusterEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#cache_cluster_enabled ApiGatewayStage#cache_cluster_enabled}.

cacheClusterSizeOptional 
public readonly cacheClusterSize: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.

clientCertificateIdOptional 
public readonly clientCertificateId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#client_certificate_id ApiGatewayStage#client_certificate_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/api_gateway_stage#description ApiGatewayStage#description}.

documentationVersionOptional 
public readonly documentationVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.

idOptional 
public readonly id: string;
  • Type: string

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

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/api_gateway_stage#tags ApiGatewayStage#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/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.

variablesOptional 
public readonly variables: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.

xrayTracingEnabledOptional 
public readonly xrayTracingEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

Classes

ApiGatewayStageAccessLogSettingsOutputReference

Initializers 

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

new apiGatewayStage.ApiGatewayStageAccessLogSettingsOutputReference(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 ApiGatewayStageAccessLogSettings 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: ApiGatewayStageAccessLogSettings;