apiGatewayStage.csharp.md

apiGatewayStage Submodule

Constructs

ApiGatewayStage

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

Initializers

using Io.Cdktn.Providers.Aws;

new ApiGatewayStage(Construct Scope, string Id, ApiGatewayStageConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	ApiGatewayStageConfig	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: ApiGatewayStageConfig

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
With	Applies one or more mixins to 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".
PutAccessLogSettings	No description.
PutCanarySettings	No description.
ResetAccessLogSettings	No description.
ResetCacheClusterEnabled	No description.
ResetCacheClusterSize	No description.
ResetCanarySettings	No description.
ResetClientCertificateId	No description.
ResetDescription	No description.
ResetDocumentationVersion	No description.
ResetId	No description.
ResetRegion	No description.
ResetTags	No description.
ResetTagsAll	No description.
ResetVariables	No description.
ResetXrayTracingEnabled	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

With

private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Mixins^Required

• Type: params Constructs.IMixin[]

The mixins to apply.

---

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: Io.Cdktn.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

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

Id^Required

• Type: string

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

---

MoveTo

private void MoveTo(string MoveTarget, string|double Index = null)

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|double

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

---

MoveToId

private void MoveToId(string Id)

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

---

PutAccessLogSettings

private void PutAccessLogSettings(ApiGatewayStageAccessLogSettings Value)

Value^Required

• Type: ApiGatewayStageAccessLogSettings

---

PutCanarySettings

private void PutCanarySettings(ApiGatewayStageCanarySettings Value)

Value^Required

• Type: ApiGatewayStageCanarySettings

---

ResetAccessLogSettings

private void ResetAccessLogSettings()

ResetCacheClusterEnabled

private void ResetCacheClusterEnabled()

ResetCacheClusterSize

private void ResetCacheClusterSize()

ResetCanarySettings

private void ResetCanarySettings()

ResetClientCertificateId

private void ResetClientCertificateId()

ResetDescription

private void ResetDescription()

ResetDocumentationVersion

private void ResetDocumentationVersion()

ResetId

private void ResetId()

ResetRegion

private void ResetRegion()

ResetTags

private void ResetTags()

ResetTagsAll

private void ResetTagsAll()

ResetVariables

private void ResetVariables()

ResetXrayTracingEnabled

private void ResetXrayTracingEnabled()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformResource	No description.
GenerateConfigForImport	Generates CDKTN code for importing a ApiGatewayStage resource upon running "cdktn plan ".

---

IsConstruct

using Io.Cdktn.Providers.Aws;

ApiGatewayStage.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using Io.Cdktn.Providers.Aws;

ApiGatewayStage.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using Io.Cdktn.Providers.Aws;

ApiGatewayStage.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using Io.Cdktn.Providers.Aws;

ApiGatewayStage.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTN code for importing a ApiGatewayStage resource upon running "cdktn 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 ApiGatewayStage to import.

---

ImportFromId^Required

• Type: string

The id of the existing ApiGatewayStage that should be imported.

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

---

Provider^Optional

• Type: Io.Cdktn.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	Io.Cdktn.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	Io.Cdktn.TerraformProviderGeneratorMetadata	No description.
Connection	Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection	No description.
Count	double|Io.Cdktn.TerraformCount	No description.
DependsOn	string[]	No description.
ForEach	Io.Cdktn.ITerraformIterator	No description.
Lifecycle	Io.Cdktn.TerraformResourceLifecycle	No description.
Provider	Io.Cdktn.TerraformProvider	No description.
Provisioners	Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]	No description.
AccessLogSettings	ApiGatewayStageAccessLogSettingsOutputReference	No description.
Arn	string	No description.
CanarySettings	ApiGatewayStageCanarySettingsOutputReference	No description.
ExecutionArn	string	No description.
InvokeUrl	string	No description.
WebAclArn	string	No description.
AccessLogSettingsInput	ApiGatewayStageAccessLogSettings	No description.
CacheClusterEnabledInput	bool|Io.Cdktn.IResolvable	No description.
CacheClusterSizeInput	string	No description.
CanarySettingsInput	ApiGatewayStageCanarySettings	No description.
ClientCertificateIdInput	string	No description.
DeploymentIdInput	string	No description.
DescriptionInput	string	No description.
DocumentationVersionInput	string	No description.
IdInput	string	No description.
RegionInput	string	No description.
RestApiIdInput	string	No description.
StageNameInput	string	No description.
TagsAllInput	System.Collections.Generic.IDictionary<string, string>	No description.
TagsInput	System.Collections.Generic.IDictionary<string, string>	No description.
VariablesInput	System.Collections.Generic.IDictionary<string, string>	No description.
XrayTracingEnabledInput	bool|Io.Cdktn.IResolvable	No description.
CacheClusterEnabled	bool|Io.Cdktn.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.
Region	string	No description.
RestApiId	string	No description.
StageName	string	No description.
Tags	System.Collections.Generic.IDictionary<string, string>	No description.
TagsAll	System.Collections.Generic.IDictionary<string, string>	No description.
Variables	System.Collections.Generic.IDictionary<string, string>	No description.
XrayTracingEnabled	bool|Io.Cdktn.IResolvable	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: Io.Cdktn.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: Io.Cdktn.TerraformProviderGeneratorMetadata

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

AccessLogSettings^Required

public ApiGatewayStageAccessLogSettingsOutputReference AccessLogSettings { get; }

• Type: ApiGatewayStageAccessLogSettingsOutputReference

---

Arn^Required

public string Arn { get; }

• Type: string

---

CanarySettings^Required

public ApiGatewayStageCanarySettingsOutputReference CanarySettings { get; }

• Type: ApiGatewayStageCanarySettingsOutputReference

---

ExecutionArn^Required

public string ExecutionArn { get; }

• Type: string

---

InvokeUrl^Required

public string InvokeUrl { get; }

• Type: string

---

WebAclArn^Required

public string WebAclArn { get; }

• Type: string

---

AccessLogSettingsInput^Optional

public ApiGatewayStageAccessLogSettings AccessLogSettingsInput { get; }

• Type: ApiGatewayStageAccessLogSettings

---

CacheClusterEnabledInput^Optional

public bool|IResolvable CacheClusterEnabledInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

CacheClusterSizeInput^Optional

public string CacheClusterSizeInput { get; }

• Type: string

---

CanarySettingsInput^Optional

public ApiGatewayStageCanarySettings CanarySettingsInput { get; }

• Type: ApiGatewayStageCanarySettings

---

ClientCertificateIdInput^Optional

public string ClientCertificateIdInput { get; }

• Type: string

---

DeploymentIdInput^Optional

public string DeploymentIdInput { get; }

• Type: string

---

DescriptionInput^Optional

public string DescriptionInput { get; }

• Type: string

---

DocumentationVersionInput^Optional

public string DocumentationVersionInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

RegionInput^Optional

public string RegionInput { get; }

• Type: string

---

RestApiIdInput^Optional

public string RestApiIdInput { get; }

• Type: string

---

StageNameInput^Optional

public string StageNameInput { get; }

• Type: string

---

TagsAllInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

VariablesInput^Optional

public System.Collections.Generic.IDictionary<string, string> VariablesInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

XrayTracingEnabledInput^Optional

public bool|IResolvable XrayTracingEnabledInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

CacheClusterEnabled^Required

public bool|IResolvable CacheClusterEnabled { get; }

• Type: bool|Io.Cdktn.IResolvable

---

CacheClusterSize^Required

public string CacheClusterSize { get; }

• Type: string

---

ClientCertificateId^Required

public string ClientCertificateId { get; }

• Type: string

---

DeploymentId^Required

public string DeploymentId { get; }

• Type: string

---

Description^Required

public string Description { get; }

• Type: string

---

DocumentationVersion^Required

public string DocumentationVersion { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Region^Required

public string Region { get; }

• Type: string

---

RestApiId^Required

public string RestApiId { get; }

• Type: string

---

StageName^Required

public string StageName { get; }

• Type: string

---

Tags^Required

public System.Collections.Generic.IDictionary<string, string> Tags { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsAll^Required

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

Variables^Required

public System.Collections.Generic.IDictionary<string, string> Variables { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

XrayTracingEnabled^Required

public bool|IResolvable XrayTracingEnabled { get; }

• Type: bool|Io.Cdktn.IResolvable

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

ApiGatewayStageAccessLogSettings

Initializer

using Io.Cdktn.Providers.Aws;

new ApiGatewayStageAccessLogSettings {
    string DestinationArn,
    string Format
};

Properties

Name	Type	Description
DestinationArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#destination_arn ApiGatewayStage#destination_arn}.
Format	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#format ApiGatewayStage#format}.

---

DestinationArn^Required

public string DestinationArn { get; set; }

• Type: string

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

---

Format^Required

public string Format { get; set; }

• Type: string

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

---

ApiGatewayStageCanarySettings

Initializer

using Io.Cdktn.Providers.Aws;

new ApiGatewayStageCanarySettings {
    string DeploymentId,
    double PercentTraffic = null,
    System.Collections.Generic.IDictionary<string, string> StageVariableOverrides = null,
    bool|IResolvable UseStageCache = null
};

Properties

Name	Type	Description
DeploymentId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
PercentTraffic	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#percent_traffic ApiGatewayStage#percent_traffic}.
StageVariableOverrides	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#stage_variable_overrides ApiGatewayStage#stage_variable_overrides}.
UseStageCache	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#use_stage_cache ApiGatewayStage#use_stage_cache}.

---

DeploymentId^Required

public string DeploymentId { get; set; }

• Type: string

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

---

PercentTraffic^Optional

public double PercentTraffic { get; set; }

• Type: double

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

---

StageVariableOverrides^Optional

public System.Collections.Generic.IDictionary<string, string> StageVariableOverrides { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

UseStageCache^Optional

public bool|IResolvable UseStageCache { get; set; }

• Type: bool|Io.Cdktn.IResolvable

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

---

ApiGatewayStageConfig

Initializer

using Io.Cdktn.Providers.Aws;

new ApiGatewayStageConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string DeploymentId,
    string RestApiId,
    string StageName,
    ApiGatewayStageAccessLogSettings AccessLogSettings = null,
    bool|IResolvable CacheClusterEnabled = null,
    string CacheClusterSize = null,
    ApiGatewayStageCanarySettings CanarySettings = null,
    string ClientCertificateId = null,
    string Description = null,
    string DocumentationVersion = null,
    string Id = null,
    string Region = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    System.Collections.Generic.IDictionary<string, string> Variables = null,
    bool|IResolvable XrayTracingEnabled = null
};

Properties

Name	Type	Description
Connection	Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection	No description.
Count	double|Io.Cdktn.TerraformCount	No description.
DependsOn	Io.Cdktn.ITerraformDependable[]	No description.
ForEach	Io.Cdktn.ITerraformIterator	No description.
Lifecycle	Io.Cdktn.TerraformResourceLifecycle	No description.
Provider	Io.Cdktn.TerraformProvider	No description.
Provisioners	Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]	No description.
DeploymentId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#deployment_id ApiGatewayStage#deployment_id}.
RestApiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/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/6.55.0/docs/resources/api_gateway_stage#stage_name ApiGatewayStage#stage_name}.
AccessLogSettings	ApiGatewayStageAccessLogSettings	access_log_settings block.
CacheClusterEnabled	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/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/6.55.0/docs/resources/api_gateway_stage#cache_cluster_size ApiGatewayStage#cache_cluster_size}.
CanarySettings	ApiGatewayStageCanarySettings	canary_settings block.
ClientCertificateId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/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/6.55.0/docs/resources/api_gateway_stage#description ApiGatewayStage#description}.
DocumentationVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#documentation_version ApiGatewayStage#documentation_version}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#id ApiGatewayStage#id}.
Region	string	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#tags ApiGatewayStage#tags}.
TagsAll	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#tags_all ApiGatewayStage#tags_all}.
Variables	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#variables ApiGatewayStage#variables}.
XrayTracingEnabled	bool|Io.Cdktn.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.55.0/docs/resources/api_gateway_stage#xray_tracing_enabled ApiGatewayStage#xray_tracing_enabled}.

---

Connection^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

• Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

---

Count^Optional

public double|TerraformCount Count { get; set; }

• Type: double|Io.Cdktn.TerraformCount

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: Io.Cdktn.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: Io.Cdktn.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: Io.Cdktn.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: Io.Cdktn.TerraformProvider

---

Provisioners^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

• Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

---

DeploymentId^Required

public string DeploymentId { get; set; }

• Type: string

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

---

RestApiId^Required

public string RestApiId { get; set; }

• Type: string

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

---

StageName^Required

public string StageName { get; set; }

• Type: string

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

---

AccessLogSettings^Optional

public ApiGatewayStageAccessLogSettings AccessLogSettings { get; set; }

• Type: ApiGatewayStageAccessLogSettings

access_log_settings block.

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

---

CacheClusterEnabled^Optional

public bool|IResolvable CacheClusterEnabled { get; set; }

• Type: bool|Io.Cdktn.IResolvable

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

---

CacheClusterSize^Optional

public string CacheClusterSize { get; set; }

• Type: string

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

---

CanarySettings^Optional

public ApiGatewayStageCanarySettings CanarySettings { get; set; }

• Type: ApiGatewayStageCanarySettings

canary_settings block.

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

---

ClientCertificateId^Optional

public string ClientCertificateId { get; set; }

• Type: string

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

---

Description^Optional

public string Description { get; set; }

• Type: string

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

---

DocumentationVersion^Optional

public string DocumentationVersion { get; set; }

• Type: string

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

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

Region^Optional

public string Region { get; set; }

• Type: string

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

---

Tags^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

TagsAll^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

Variables^Optional

public System.Collections.Generic.IDictionary<string, string> Variables { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

XrayTracingEnabled^Optional

public bool|IResolvable XrayTracingEnabled { get; set; }

• Type: bool|Io.Cdktn.IResolvable

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

---

Classes

ApiGatewayStageAccessLogSettingsOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new ApiGatewayStageAccessLogSettingsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	Io.Cdktn.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

• Type: Io.Cdktn.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.

---

ComputeFqn

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: Io.Cdktn.IResolveContext

---

ToString

private string ToString()

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.

---

CreationStack^Required

public string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

DestinationArnInput^Optional

public string DestinationArnInput { get; }

• Type: string

---

FormatInput^Optional

public string FormatInput { get; }

• Type: string

---

DestinationArn^Required

public string DestinationArn { get; }

• Type: string

---

Format^Required

public string Format { get; }

• Type: string

---

InternalValue^Optional

public ApiGatewayStageAccessLogSettings InternalValue { get; }

• Type: ApiGatewayStageAccessLogSettings

---

ApiGatewayStageCanarySettingsOutputReference

Initializers

using Io.Cdktn.Providers.Aws;

new ApiGatewayStageCanarySettingsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	Io.Cdktn.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

• Type: Io.Cdktn.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.
ResetPercentTraffic	No description.
ResetStageVariableOverrides	No description.
ResetUseStageCache	No description.

---

ComputeFqn

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: Io.Cdktn.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetPercentTraffic

private void ResetPercentTraffic()

ResetStageVariableOverrides

private void ResetStageVariableOverrides()

ResetUseStageCache

private void ResetUseStageCache()

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.
DeploymentIdInput	string	No description.
PercentTrafficInput	double	No description.
StageVariableOverridesInput	System.Collections.Generic.IDictionary<string, string>	No description.
UseStageCacheInput	bool|Io.Cdktn.IResolvable	No description.
DeploymentId	string	No description.
PercentTraffic	double	No description.
StageVariableOverrides	System.Collections.Generic.IDictionary<string, string>	No description.
UseStageCache	bool|Io.Cdktn.IResolvable	No description.
InternalValue	ApiGatewayStageCanarySettings	No description.

---

CreationStack^Required

public string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

DeploymentIdInput^Optional

public string DeploymentIdInput { get; }

• Type: string

---

PercentTrafficInput^Optional

public double PercentTrafficInput { get; }

• Type: double

---

StageVariableOverridesInput^Optional

public System.Collections.Generic.IDictionary<string, string> StageVariableOverridesInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

UseStageCacheInput^Optional

public bool|IResolvable UseStageCacheInput { get; }

• Type: bool|Io.Cdktn.IResolvable

---

DeploymentId^Required

public string DeploymentId { get; }

• Type: string

---

PercentTraffic^Required

public double PercentTraffic { get; }

• Type: double

---

StageVariableOverrides^Required

public System.Collections.Generic.IDictionary<string, string> StageVariableOverrides { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

UseStageCache^Required

public bool|IResolvable UseStageCache { get; }

• Type: bool|Io.Cdktn.IResolvable

---

InternalValue^Optional

public ApiGatewayStageCanarySettings InternalValue { get; }

• Type: ApiGatewayStageCanarySettings

---