`apigatewayv2Route` Submodule

Constructs

Apigatewayv2Route

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route aws_apigatewayv2_route}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2Route(Construct Scope, string Id, Apigatewayv2RouteConfig Config);

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

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".
`PutRequestParameter`	No description.
`ResetApiKeyRequired`	No description.
`ResetAuthorizationScopes`	No description.
`ResetAuthorizationType`	No description.
`ResetAuthorizerId`	No description.
`ResetId`	No description.
`ResetModelSelectionExpression`	No description.
`ResetOperationName`	No description.
`ResetRequestModels`	No description.
`ResetRequestParameter`	No description.
`ResetRouteResponseSelectionExpression`	No description.
`ResetTarget`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`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 object HasResourceMove()

`ImportFrom`

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

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.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, object 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: 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".

`Id`^Required

Type: string

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

`PutRequestParameter`

private void PutRequestParameter(object Value)

`Value`^Required

Type: object

`ResetApiKeyRequired`

private void ResetApiKeyRequired()

`ResetAuthorizationScopes`

private void ResetAuthorizationScopes()

`ResetAuthorizationType`

private void ResetAuthorizationType()

`ResetAuthorizerId`

private void ResetAuthorizerId()

`ResetId`

private void ResetId()

`ResetModelSelectionExpression`

private void ResetModelSelectionExpression()

`ResetOperationName`

private void ResetOperationName()

`ResetRequestModels`

private void ResetRequestModels()

`ResetRequestParameter`

private void ResetRequestParameter()

`ResetRouteResponseSelectionExpression`

private void ResetRouteResponseSelectionExpression()

`ResetTarget`

private void ResetTarget()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Aws;

Apigatewayv2Route.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 HashiCorp.Cdktf.Providers.Aws;

Apigatewayv2Route.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Aws;

Apigatewayv2Route.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a Apigatewayv2Route 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 Apigatewayv2Route to import.

`ImportFromId`^Required

Type: string

The id of the existing Apigatewayv2Route that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the Apigatewayv2Route 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.
`RequestParameter`	`Apigatewayv2RouteRequestParameterList`	No description.
`ApiIdInput`	`string`	No description.
`ApiKeyRequiredInput`	`object`	No description.
`AuthorizationScopesInput`	`string[]`	No description.
`AuthorizationTypeInput`	`string`	No description.
`AuthorizerIdInput`	`string`	No description.
`IdInput`	`string`	No description.
`ModelSelectionExpressionInput`	`string`	No description.
`OperationNameInput`	`string`	No description.
`RequestModelsInput`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`RequestParameterInput`	`object`	No description.
`RouteKeyInput`	`string`	No description.
`RouteResponseSelectionExpressionInput`	`string`	No description.
`TargetInput`	`string`	No description.
`ApiId`	`string`	No description.
`ApiKeyRequired`	`object`	No description.
`AuthorizationScopes`	`string[]`	No description.
`AuthorizationType`	`string`	No description.
`AuthorizerId`	`string`	No description.
`Id`	`string`	No description.
`ModelSelectionExpression`	`string`	No description.
`OperationName`	`string`	No description.
`RequestModels`	`System.Collections.Generic.IDictionary<string, string>`	No description.
`RouteKey`	`string`	No description.
`RouteResponseSelectionExpression`	`string`	No description.
`Target`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.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: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`RequestParameter`^Required

public Apigatewayv2RouteRequestParameterList RequestParameter { get; }

Type: Apigatewayv2RouteRequestParameterList

`ApiIdInput`^Optional

public string ApiIdInput { get; }

Type: string

`ApiKeyRequiredInput`^Optional

public object ApiKeyRequiredInput { get; }

Type: object

`AuthorizationScopesInput`^Optional

public string[] AuthorizationScopesInput { get; }

Type: string[]

`AuthorizationTypeInput`^Optional

public string AuthorizationTypeInput { get; }

Type: string

`AuthorizerIdInput`^Optional

public string AuthorizerIdInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`ModelSelectionExpressionInput`^Optional

public string ModelSelectionExpressionInput { get; }

Type: string

`OperationNameInput`^Optional

public string OperationNameInput { get; }

Type: string

`RequestModelsInput`^Optional

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

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

`RequestParameterInput`^Optional

public object RequestParameterInput { get; }

Type: object

`RouteKeyInput`^Optional

public string RouteKeyInput { get; }

Type: string

`RouteResponseSelectionExpressionInput`^Optional

public string RouteResponseSelectionExpressionInput { get; }

Type: string

`TargetInput`^Optional

public string TargetInput { get; }

Type: string

`ApiId`^Required

public string ApiId { get; }

Type: string

`ApiKeyRequired`^Required

public object ApiKeyRequired { get; }

Type: object

`AuthorizationScopes`^Required

public string[] AuthorizationScopes { get; }

Type: string[]

`AuthorizationType`^Required

public string AuthorizationType { get; }

Type: string

`AuthorizerId`^Required

public string AuthorizerId { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`ModelSelectionExpression`^Required

public string ModelSelectionExpression { get; }

Type: string

`OperationName`^Required

public string OperationName { get; }

Type: string

`RequestModels`^Required

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

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

`RouteKey`^Required

public string RouteKey { get; }

Type: string

`RouteResponseSelectionExpression`^Required

public string RouteResponseSelectionExpression { get; }

Type: string

`Target`^Required

public string Target { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

Apigatewayv2RouteConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2RouteConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ApiId,
    string RouteKey,
    object ApiKeyRequired = null,
    string[] AuthorizationScopes = null,
    string AuthorizationType = null,
    string AuthorizerId = null,
    string Id = null,
    string ModelSelectionExpression = null,
    string OperationName = null,
    System.Collections.Generic.IDictionary<string, string> RequestModels = null,
    object RequestParameter = null,
    string RouteResponseSelectionExpression = null,
    string Target = 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.
`ApiId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#api_id Apigatewayv2Route#api_id}.
`RouteKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#route_key Apigatewayv2Route#route_key}.
`ApiKeyRequired`	`object`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#api_key_required Apigatewayv2Route#api_key_required}.
`AuthorizationScopes`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorization_scopes Apigatewayv2Route#authorization_scopes}.
`AuthorizationType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorization_type Apigatewayv2Route#authorization_type}.
`AuthorizerId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorizer_id Apigatewayv2Route#authorizer_id}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#id Apigatewayv2Route#id}.
`ModelSelectionExpression`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#model_selection_expression Apigatewayv2Route#model_selection_expression}.
`OperationName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#operation_name Apigatewayv2Route#operation_name}.
`RequestModels`	`System.Collections.Generic.IDictionary<string, string>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#request_models Apigatewayv2Route#request_models}.
`RequestParameter`	`object`	request_parameter block.
`RouteResponseSelectionExpression`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#route_response_selection_expression Apigatewayv2Route#route_response_selection_expression}.
`Target`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#target Apigatewayv2Route#target}.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`ApiId`^Required

public string ApiId { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#api_id Apigatewayv2Route#api_id}.

`RouteKey`^Required

public string RouteKey { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#route_key Apigatewayv2Route#route_key}.

`ApiKeyRequired`^Optional

public object ApiKeyRequired { get; set; }

Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#api_key_required Apigatewayv2Route#api_key_required}.

`AuthorizationScopes`^Optional

public string[] AuthorizationScopes { get; set; }

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorization_scopes Apigatewayv2Route#authorization_scopes}.

`AuthorizationType`^Optional

public string AuthorizationType { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorization_type Apigatewayv2Route#authorization_type}.

`AuthorizerId`^Optional

public string AuthorizerId { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#authorizer_id Apigatewayv2Route#authorizer_id}.

`Id`^Optional

public string Id { get; set; }

Type: string

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

`ModelSelectionExpression`^Optional

public string ModelSelectionExpression { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#model_selection_expression Apigatewayv2Route#model_selection_expression}.

`OperationName`^Optional

public string OperationName { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#operation_name Apigatewayv2Route#operation_name}.

`RequestModels`^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#request_models Apigatewayv2Route#request_models}.

`RequestParameter`^Optional

public object RequestParameter { get; set; }

Type: object

request_parameter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#request_parameter Apigatewayv2Route#request_parameter}

`RouteResponseSelectionExpression`^Optional

public string RouteResponseSelectionExpression { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#route_response_selection_expression Apigatewayv2Route#route_response_selection_expression}.

`Target`^Optional

public string Target { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#target Apigatewayv2Route#target}.

Apigatewayv2RouteRequestParameter

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2RouteRequestParameter {
    string RequestParameterKey,
    object Required
};

Properties

Name	Type	Description
`RequestParameterKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#request_parameter_key Apigatewayv2Route#request_parameter_key}.
`Required`	`object`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#required Apigatewayv2Route#required}.

`RequestParameterKey`^Required

public string RequestParameterKey { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#request_parameter_key Apigatewayv2Route#request_parameter_key}.

`Required`^Required

public object Required { get; set; }

Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/apigatewayv2_route#required Apigatewayv2Route#required}.

Classes

Apigatewayv2RouteRequestParameterList

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2RouteRequestParameterList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

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

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private Apigatewayv2RouteRequestParameterOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	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

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Apigatewayv2RouteRequestParameterOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new Apigatewayv2RouteRequestParameterOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

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

Methods

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

`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: HashiCorp.Cdktf.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.
`RequestParameterKeyInput`	`string`	No description.
`RequiredInput`	`object`	No description.
`RequestParameterKey`	`string`	No description.
`Required`	`object`	No description.
`InternalValue`	`object`	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

`RequestParameterKeyInput`^Optional

public string RequestParameterKeyInput { get; }

Type: string

`RequiredInput`^Optional

public object RequiredInput { get; }

Type: object

`RequestParameterKey`^Required

public string RequestParameterKey { get; }

Type: string

`Required`^Required

public object Required { get; }

Type: object

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

apigatewayv2Route.csharp.md

Latest commit

History

apigatewayv2Route.csharp.md

File metadata and controls

apigatewayv2Route Submodule

Constructs