apiGatewayMethodSettings.md

apiGatewayMethodSettings Submodule

Constructs

ApiGatewayMethodSettings

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

Initializers

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

new apiGatewayMethodSettings.ApiGatewayMethodSettings(scope: Construct, id: string, config: ApiGatewayMethodSettingsConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ApiGatewayMethodSettingsConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ApiGatewayMethodSettingsConfig

---

Methods

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

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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

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

id^Required

• Type: string

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

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

putSettings

public putSettings(value: ApiGatewayMethodSettingsSettings): void

value^Required

• Type: ApiGatewayMethodSettingsSettings

---

resetId

public resetId(): void

Static Functions

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

---

isConstruct

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

apiGatewayMethodSettings.ApiGatewayMethodSettings.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

apiGatewayMethodSettings.ApiGatewayMethodSettings.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

apiGatewayMethodSettings.ApiGatewayMethodSettings.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

apiGatewayMethodSettings.ApiGatewayMethodSettings.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ApiGatewayMethodSettings resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the ApiGatewayMethodSettings to import.

---

importFromId^Required

• Type: string

The id of the existing ApiGatewayMethodSettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ApiGatewayMethodSettings to import is found.

---

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.
settings	ApiGatewayMethodSettingsSettingsOutputReference	No description.
idInput	string	No description.
methodPathInput	string	No description.
restApiIdInput	string	No description.
settingsInput	ApiGatewayMethodSettingsSettings	No description.
stageNameInput	string	No description.
id	string	No description.
methodPath	string	No description.
restApiId	string	No description.
stageName	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

settings^Required

public readonly settings: ApiGatewayMethodSettingsSettingsOutputReference;

• Type: ApiGatewayMethodSettingsSettingsOutputReference

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

methodPathInput^Optional

public readonly methodPathInput: string;

• Type: string

---

restApiIdInput^Optional

public readonly restApiIdInput: string;

• Type: string

---

settingsInput^Optional

public readonly settingsInput: ApiGatewayMethodSettingsSettings;

• Type: ApiGatewayMethodSettingsSettings

---

stageNameInput^Optional

public readonly stageNameInput: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

methodPath^Required

public readonly methodPath: string;

• Type: string

---

restApiId^Required

public readonly restApiId: string;

• Type: string

---

stageName^Required

public readonly stageName: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApiGatewayMethodSettingsConfig

Initializer

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

const apiGatewayMethodSettingsConfig: apiGatewayMethodSettings.ApiGatewayMethodSettingsConfig = { ... }

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.
methodPath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#method_path ApiGatewayMethodSettings#method_path}.
restApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#rest_api_id ApiGatewayMethodSettings#rest_api_id}.
settings	ApiGatewayMethodSettingsSettings	settings block.
stageName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#stage_name ApiGatewayMethodSettings#stage_name}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#id ApiGatewayMethodSettings#id}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

methodPath^Required

public readonly methodPath: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#method_path ApiGatewayMethodSettings#method_path}.

---

restApiId^Required

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_method_settings#rest_api_id ApiGatewayMethodSettings#rest_api_id}.

---

settings^Required

public readonly settings: ApiGatewayMethodSettingsSettings;

• Type: ApiGatewayMethodSettingsSettings

settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#settings ApiGatewayMethodSettings#settings}

---

stageName^Required

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_method_settings#stage_name ApiGatewayMethodSettings#stage_name}.

---

id^Optional

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_method_settings#id ApiGatewayMethodSettings#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.

---

ApiGatewayMethodSettingsSettings

Initializer

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

const apiGatewayMethodSettingsSettings: apiGatewayMethodSettings.ApiGatewayMethodSettingsSettings = { ... }

Properties

Name	Type	Description
cacheDataEncrypted	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#cache_data_encrypted ApiGatewayMethodSettings#cache_data_encrypted}.
cacheTtlInSeconds	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#cache_ttl_in_seconds ApiGatewayMethodSettings#cache_ttl_in_seconds}.
cachingEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#caching_enabled ApiGatewayMethodSettings#caching_enabled}.
dataTraceEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#data_trace_enabled ApiGatewayMethodSettings#data_trace_enabled}.
loggingLevel	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#logging_level ApiGatewayMethodSettings#logging_level}.
metricsEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#metrics_enabled ApiGatewayMethodSettings#metrics_enabled}.
requireAuthorizationForCacheControl	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#require_authorization_for_cache_control ApiGatewayMethodSettings#require_authorization_for_cache_control}.
throttlingBurstLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#throttling_burst_limit ApiGatewayMethodSettings#throttling_burst_limit}.
throttlingRateLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#throttling_rate_limit ApiGatewayMethodSettings#throttling_rate_limit}.
unauthorizedCacheControlHeaderStrategy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#unauthorized_cache_control_header_strategy ApiGatewayMethodSettings#unauthorized_cache_control_header_strategy}.

---

cacheDataEncrypted^Optional

public readonly cacheDataEncrypted: 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_method_settings#cache_data_encrypted ApiGatewayMethodSettings#cache_data_encrypted}.

---

cacheTtlInSeconds^Optional

public readonly cacheTtlInSeconds: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#cache_ttl_in_seconds ApiGatewayMethodSettings#cache_ttl_in_seconds}.

---

cachingEnabled^Optional

public readonly cachingEnabled: 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_method_settings#caching_enabled ApiGatewayMethodSettings#caching_enabled}.

---

dataTraceEnabled^Optional

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/api_gateway_method_settings#data_trace_enabled ApiGatewayMethodSettings#data_trace_enabled}.

---

loggingLevel^Optional

public readonly loggingLevel: string;

• Type: string

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

---

metricsEnabled^Optional

public readonly metricsEnabled: 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_method_settings#metrics_enabled ApiGatewayMethodSettings#metrics_enabled}.

---

requireAuthorizationForCacheControl^Optional

public readonly requireAuthorizationForCacheControl: 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_method_settings#require_authorization_for_cache_control ApiGatewayMethodSettings#require_authorization_for_cache_control}.

---

throttlingBurstLimit^Optional

public readonly throttlingBurstLimit: number;

• Type: number

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

---

throttlingRateLimit^Optional

public readonly throttlingRateLimit: number;

• Type: number

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

---

unauthorizedCacheControlHeaderStrategy^Optional

public readonly unauthorizedCacheControlHeaderStrategy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_method_settings#unauthorized_cache_control_header_strategy ApiGatewayMethodSettings#unauthorized_cache_control_header_strategy}.

---

Classes

ApiGatewayMethodSettingsSettingsOutputReference

Initializers

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

new apiGatewayMethodSettings.ApiGatewayMethodSettingsSettingsOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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.
resetCacheDataEncrypted	No description.
resetCacheTtlInSeconds	No description.
resetCachingEnabled	No description.
resetDataTraceEnabled	No description.
resetLoggingLevel	No description.
resetMetricsEnabled	No description.
resetRequireAuthorizationForCacheControl	No description.
resetThrottlingBurstLimit	No description.
resetThrottlingRateLimit	No description.
resetUnauthorizedCacheControlHeaderStrategy	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCacheDataEncrypted

public resetCacheDataEncrypted(): void

resetCacheTtlInSeconds

public resetCacheTtlInSeconds(): void

resetCachingEnabled

public resetCachingEnabled(): void

resetDataTraceEnabled

public resetDataTraceEnabled(): void

resetLoggingLevel

public resetLoggingLevel(): void

resetMetricsEnabled

public resetMetricsEnabled(): void

resetRequireAuthorizationForCacheControl

public resetRequireAuthorizationForCacheControl(): void

resetThrottlingBurstLimit

public resetThrottlingBurstLimit(): void

resetThrottlingRateLimit

public resetThrottlingRateLimit(): void

resetUnauthorizedCacheControlHeaderStrategy

public resetUnauthorizedCacheControlHeaderStrategy(): 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.
cacheDataEncryptedInput	boolean | cdktf.IResolvable	No description.
cacheTtlInSecondsInput	number	No description.
cachingEnabledInput	boolean | cdktf.IResolvable	No description.
dataTraceEnabledInput	boolean | cdktf.IResolvable	No description.
loggingLevelInput	string	No description.
metricsEnabledInput	boolean | cdktf.IResolvable	No description.
requireAuthorizationForCacheControlInput	boolean | cdktf.IResolvable	No description.
throttlingBurstLimitInput	number	No description.
throttlingRateLimitInput	number	No description.
unauthorizedCacheControlHeaderStrategyInput	string	No description.
cacheDataEncrypted	boolean | cdktf.IResolvable	No description.
cacheTtlInSeconds	number	No description.
cachingEnabled	boolean | cdktf.IResolvable	No description.
dataTraceEnabled	boolean | cdktf.IResolvable	No description.
loggingLevel	string	No description.
metricsEnabled	boolean | cdktf.IResolvable	No description.
requireAuthorizationForCacheControl	boolean | cdktf.IResolvable	No description.
throttlingBurstLimit	number	No description.
throttlingRateLimit	number	No description.
unauthorizedCacheControlHeaderStrategy	string	No description.
internalValue	ApiGatewayMethodSettingsSettings	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

cacheDataEncryptedInput^Optional

public readonly cacheDataEncryptedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

cacheTtlInSecondsInput^Optional

public readonly cacheTtlInSecondsInput: number;

• Type: number

---

cachingEnabledInput^Optional

public readonly cachingEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

dataTraceEnabledInput^Optional

public readonly dataTraceEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

loggingLevelInput^Optional

public readonly loggingLevelInput: string;

• Type: string

---

metricsEnabledInput^Optional

public readonly metricsEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

requireAuthorizationForCacheControlInput^Optional

public readonly requireAuthorizationForCacheControlInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

throttlingBurstLimitInput^Optional

public readonly throttlingBurstLimitInput: number;

• Type: number

---

throttlingRateLimitInput^Optional

public readonly throttlingRateLimitInput: number;

• Type: number

---

unauthorizedCacheControlHeaderStrategyInput^Optional

public readonly unauthorizedCacheControlHeaderStrategyInput: string;

• Type: string

---

cacheDataEncrypted^Required

public readonly cacheDataEncrypted: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

cacheTtlInSeconds^Required

public readonly cacheTtlInSeconds: number;

• Type: number

---

cachingEnabled^Required

public readonly cachingEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

dataTraceEnabled^Required

public readonly dataTraceEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

loggingLevel^Required

public readonly loggingLevel: string;

• Type: string

---

metricsEnabled^Required

public readonly metricsEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

requireAuthorizationForCacheControl^Required

public readonly requireAuthorizationForCacheControl: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

throttlingBurstLimit^Required

public readonly throttlingBurstLimit: number;

• Type: number

---

throttlingRateLimit^Required

public readonly throttlingRateLimit: number;

• Type: number

---

unauthorizedCacheControlHeaderStrategy^Required

public readonly unauthorizedCacheControlHeaderStrategy: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: ApiGatewayMethodSettingsSettings;

• Type: ApiGatewayMethodSettingsSettings

---