Skip to content

Latest commit

 

History

History
2019 lines (1273 loc) · 86.4 KB

apigatewayv2Api.csharp.md

File metadata and controls

2019 lines (1273 loc) · 86.4 KB

apigatewayv2Api Submodule

Constructs

Apigatewayv2Api

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

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2Api(Construct Scope, string Id, Apigatewayv2ApiConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config Apigatewayv2ApiConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
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".
PutCorsConfiguration No description.
ResetApiKeySelectionExpression No description.
ResetBody No description.
ResetCorsConfiguration No description.
ResetCredentialsArn No description.
ResetDescription No description.
ResetDisableExecuteApiEndpoint No description.
ResetFailOnWarnings No description.
ResetId No description.
ResetRouteKey No description.
ResetRouteSelectionExpression No description.
ResetTags No description.
ResetTagsAll No description.
ResetTarget No description.
ResetVersion No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

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

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • 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.

IdRequired
  • Type: string

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


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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


IndexOptional
  • Type: object

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

IdRequired
  • Type: string

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


PutCorsConfiguration
private void PutCorsConfiguration(Apigatewayv2ApiCorsConfiguration Value)
ValueRequired

ResetApiKeySelectionExpression
private void ResetApiKeySelectionExpression()
ResetBody
private void ResetBody()
ResetCorsConfiguration
private void ResetCorsConfiguration()
ResetCredentialsArn
private void ResetCredentialsArn()
ResetDescription
private void ResetDescription()
ResetDisableExecuteApiEndpoint
private void ResetDisableExecuteApiEndpoint()
ResetFailOnWarnings
private void ResetFailOnWarnings()
ResetId
private void ResetId()
ResetRouteKey
private void ResetRouteKey()
ResetRouteSelectionExpression
private void ResetRouteSelectionExpression()
ResetTags
private void ResetTags()
ResetTagsAll
private void ResetTagsAll()
ResetTarget
private void ResetTarget()
ResetVersion
private void ResetVersion()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

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

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Aws;

Apigatewayv2Api.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

Apigatewayv2Api.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

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


ImportFromIdRequired
  • Type: string

The id of the existing Apigatewayv2Api that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.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 HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ApiEndpoint string No description.
Arn string No description.
CorsConfiguration Apigatewayv2ApiCorsConfigurationOutputReference No description.
ExecutionArn string No description.
ApiKeySelectionExpressionInput string No description.
BodyInput string No description.
CorsConfigurationInput Apigatewayv2ApiCorsConfiguration No description.
CredentialsArnInput string No description.
DescriptionInput string No description.
DisableExecuteApiEndpointInput object No description.
FailOnWarningsInput object No description.
IdInput string No description.
NameInput string No description.
ProtocolTypeInput string No description.
RouteKeyInput string No description.
RouteSelectionExpressionInput string No description.
TagsAllInput System.Collections.Generic.IDictionary<string, string> No description.
TagsInput System.Collections.Generic.IDictionary<string, string> No description.
TargetInput string No description.
VersionInput string No description.
ApiKeySelectionExpression string No description.
Body string No description.
CredentialsArn string No description.
Description string No description.
DisableExecuteApiEndpoint object No description.
FailOnWarnings object No description.
Id string No description.
Name string No description.
ProtocolType string No description.
RouteKey string No description.
RouteSelectionExpression string No description.
Tags System.Collections.Generic.IDictionary<string, string> No description.
TagsAll System.Collections.Generic.IDictionary<string, string> No description.
Target string No description.
Version string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

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

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ApiEndpointRequired
public string ApiEndpoint { get; }
  • Type: string

ArnRequired
public string Arn { get; }
  • Type: string

CorsConfigurationRequired
public Apigatewayv2ApiCorsConfigurationOutputReference CorsConfiguration { get; }

ExecutionArnRequired
public string ExecutionArn { get; }
  • Type: string

ApiKeySelectionExpressionInputOptional
public string ApiKeySelectionExpressionInput { get; }
  • Type: string

BodyInputOptional
public string BodyInput { get; }
  • Type: string

CorsConfigurationInputOptional
public Apigatewayv2ApiCorsConfiguration CorsConfigurationInput { get; }

CredentialsArnInputOptional
public string CredentialsArnInput { get; }
  • Type: string

DescriptionInputOptional
public string DescriptionInput { get; }
  • Type: string

DisableExecuteApiEndpointInputOptional
public object DisableExecuteApiEndpointInput { get; }
  • Type: object

FailOnWarningsInputOptional
public object FailOnWarningsInput { get; }
  • Type: object

IdInputOptional
public string IdInput { get; }
  • Type: string

NameInputOptional
public string NameInput { get; }
  • Type: string

ProtocolTypeInputOptional
public string ProtocolTypeInput { get; }
  • Type: string

RouteKeyInputOptional
public string RouteKeyInput { get; }
  • Type: string

RouteSelectionExpressionInputOptional
public string RouteSelectionExpressionInput { get; }
  • Type: string

TagsAllInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetInputOptional
public string TargetInput { get; }
  • Type: string

VersionInputOptional
public string VersionInput { get; }
  • Type: string

ApiKeySelectionExpressionRequired
public string ApiKeySelectionExpression { get; }
  • Type: string

BodyRequired
public string Body { get; }
  • Type: string

CredentialsArnRequired
public string CredentialsArn { get; }
  • Type: string

DescriptionRequired
public string Description { get; }
  • Type: string

DisableExecuteApiEndpointRequired
public object DisableExecuteApiEndpoint { get; }
  • Type: object

FailOnWarningsRequired
public object FailOnWarnings { get; }
  • Type: object

IdRequired
public string Id { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

ProtocolTypeRequired
public string ProtocolType { get; }
  • Type: string

RouteKeyRequired
public string RouteKey { get; }
  • Type: string

RouteSelectionExpressionRequired
public string RouteSelectionExpression { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TagsAllRequired
public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TargetRequired
public string Target { get; }
  • Type: string

VersionRequired
public string Version { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

Apigatewayv2ApiConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2ApiConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string ProtocolType,
    string ApiKeySelectionExpression = null,
    string Body = null,
    Apigatewayv2ApiCorsConfiguration CorsConfiguration = null,
    string CredentialsArn = null,
    string Description = null,
    object DisableExecuteApiEndpoint = null,
    object FailOnWarnings = null,
    string Id = null,
    string RouteKey = null,
    string RouteSelectionExpression = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    string Target = null,
    string Version = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
ProtocolType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
ApiKeySelectionExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
Body string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
CorsConfiguration Apigatewayv2ApiCorsConfiguration cors_configuration block.
CredentialsArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
Description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
DisableExecuteApiEndpoint object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
FailOnWarnings object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.
RouteKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
RouteSelectionExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
Tags System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
TagsAll System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
Target string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
Version string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

NameRequired
public string Name { get; set; }
  • Type: string

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


ProtocolTypeRequired
public string ProtocolType { get; set; }
  • Type: string

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


ApiKeySelectionExpressionOptional
public string ApiKeySelectionExpression { get; set; }
  • Type: string

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


BodyOptional
public string Body { get; set; }
  • Type: string

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


CorsConfigurationOptional
public Apigatewayv2ApiCorsConfiguration CorsConfiguration { get; set; }

cors_configuration block.

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


CredentialsArnOptional
public string CredentialsArn { get; set; }
  • Type: string

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


DescriptionOptional
public string Description { get; set; }
  • Type: string

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


DisableExecuteApiEndpointOptional
public object DisableExecuteApiEndpoint { get; set; }
  • Type: object

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


FailOnWarningsOptional
public object FailOnWarnings { get; set; }
  • Type: object

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


IdOptional
public string Id { get; set; }
  • Type: string

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


RouteKeyOptional
public string RouteKey { get; set; }
  • Type: string

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


RouteSelectionExpressionOptional
public string RouteSelectionExpression { get; set; }
  • Type: string

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


TagsOptional
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/5.52.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.


TagsAllOptional
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/5.52.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.


TargetOptional
public string Target { get; set; }
  • Type: string

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


VersionOptional
public string Version { get; set; }
  • Type: string

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


Apigatewayv2ApiCorsConfiguration

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2ApiCorsConfiguration {
    object AllowCredentials = null,
    string[] AllowHeaders = null,
    string[] AllowMethods = null,
    string[] AllowOrigins = null,
    string[] ExposeHeaders = null,
    double MaxAge = null
};

Properties

Name Type Description
AllowCredentials object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.
AllowHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.
AllowMethods string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.
AllowOrigins string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.
ExposeHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.
MaxAge double Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

AllowCredentialsOptional
public object AllowCredentials { get; set; }
  • Type: object

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


AllowHeadersOptional
public string[] AllowHeaders { get; set; }
  • Type: string[]

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


AllowMethodsOptional
public string[] AllowMethods { get; set; }
  • Type: string[]

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


AllowOriginsOptional
public string[] AllowOrigins { get; set; }
  • Type: string[]

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


ExposeHeadersOptional
public string[] ExposeHeaders { get; set; }
  • Type: string[]

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


MaxAgeOptional
public double MaxAge { get; set; }
  • Type: double

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


Classes

Apigatewayv2ApiCorsConfigurationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2ApiCorsConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetAllowCredentials No description.
ResetAllowHeaders No description.
ResetAllowMethods No description.
ResetAllowOrigins No description.
ResetExposeHeaders No description.
ResetMaxAge No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetAllowCredentials
private void ResetAllowCredentials()
ResetAllowHeaders
private void ResetAllowHeaders()
ResetAllowMethods
private void ResetAllowMethods()
ResetAllowOrigins
private void ResetAllowOrigins()
ResetExposeHeaders
private void ResetExposeHeaders()
ResetMaxAge
private void ResetMaxAge()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
AllowCredentialsInput object No description.
AllowHeadersInput string[] No description.
AllowMethodsInput string[] No description.
AllowOriginsInput string[] No description.
ExposeHeadersInput string[] No description.
MaxAgeInput double No description.
AllowCredentials object No description.
AllowHeaders string[] No description.
AllowMethods string[] No description.
AllowOrigins string[] No description.
ExposeHeaders string[] No description.
MaxAge double No description.
InternalValue Apigatewayv2ApiCorsConfiguration No description.

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


FqnRequired
public string Fqn { get; }
  • Type: string

AllowCredentialsInputOptional
public object AllowCredentialsInput { get; }
  • Type: object

AllowHeadersInputOptional
public string[] AllowHeadersInput { get; }
  • Type: string[]

AllowMethodsInputOptional
public string[] AllowMethodsInput { get; }
  • Type: string[]

AllowOriginsInputOptional
public string[] AllowOriginsInput { get; }
  • Type: string[]

ExposeHeadersInputOptional
public string[] ExposeHeadersInput { get; }
  • Type: string[]

MaxAgeInputOptional
public double MaxAgeInput { get; }
  • Type: double

AllowCredentialsRequired
public object AllowCredentials { get; }
  • Type: object

AllowHeadersRequired
public string[] AllowHeaders { get; }
  • Type: string[]

AllowMethodsRequired
public string[] AllowMethods { get; }
  • Type: string[]

AllowOriginsRequired
public string[] AllowOrigins { get; }
  • Type: string[]

ExposeHeadersRequired
public string[] ExposeHeaders { get; }
  • Type: string[]

MaxAgeRequired
public double MaxAge { get; }
  • Type: double

InternalValueOptional
public Apigatewayv2ApiCorsConfiguration InternalValue { get; }