CfnGatewayRoute

class aws_cdk.aws_appmesh.CfnGatewayRoute(scope, id, *, mesh_name, spec, virtual_gateway_name, gateway_route_name=None, mesh_owner=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AppMesh::GatewayRoute.

CloudformationResource

AWS::AppMesh::GatewayRoute

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html

Create a new AWS::AppMesh::GatewayRoute.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • mesh_name (str) – AWS::AppMesh::GatewayRoute.MeshName.

  • spec (Union[GatewayRouteSpecProperty, IResolvable]) – AWS::AppMesh::GatewayRoute.Spec.

  • virtual_gateway_name (str) – AWS::AppMesh::GatewayRoute.VirtualGatewayName.

  • gateway_route_name (Optional[str]) – AWS::AppMesh::GatewayRoute.GatewayRouteName.

  • mesh_owner (Optional[str]) – AWS::AppMesh::GatewayRoute.MeshOwner.

  • tags (Optional[Sequence[CfnTag]]) – AWS::AppMesh::GatewayRoute.Tags.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AppMesh::GatewayRoute'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_gateway_route_name

GatewayRouteName

Type

cloudformationAttribute

Return type

str

attr_mesh_name

MeshName

Type

cloudformationAttribute

Return type

str

attr_mesh_owner

MeshOwner

Type

cloudformationAttribute

Return type

str

attr_resource_owner

ResourceOwner

Type

cloudformationAttribute

Return type

str

attr_uid

Uid

Type

cloudformationAttribute

Return type

str

attr_virtual_gateway_name

VirtualGatewayName

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

gateway_route_name

AWS::AppMesh::GatewayRoute.GatewayRouteName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

mesh_name

AWS::AppMesh::GatewayRoute.MeshName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname

Return type

str

mesh_owner

AWS::AppMesh::GatewayRoute.MeshOwner.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

spec

AWS::AppMesh::GatewayRoute.Spec.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec

Return type

Union[GatewayRouteSpecProperty, IResolvable]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::AppMesh::GatewayRoute.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags

Return type

TagManager

virtual_gateway_name

AWS::AppMesh::GatewayRoute.VirtualGatewayName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname

Return type

str

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

GatewayRouteHostnameMatchProperty

class CfnGatewayRoute.GatewayRouteHostnameMatchProperty(*, exact=None, suffix=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnGatewayRoute.GatewayRouteHostnameMatchProperty.Exact.

  • suffix (Optional[str]) – CfnGatewayRoute.GatewayRouteHostnameMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html

Attributes

exact

CfnGatewayRoute.GatewayRouteHostnameMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-exact

Return type

Optional[str]

suffix

CfnGatewayRoute.GatewayRouteHostnameMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-suffix

Return type

Optional[str]

GatewayRouteHostnameRewriteProperty

class CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(*, default_target_hostname=None)

Bases: object

Parameters

default_target_hostname (Optional[str]) – CfnGatewayRoute.GatewayRouteHostnameRewriteProperty.DefaultTargetHostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html

Attributes

default_target_hostname

CfnGatewayRoute.GatewayRouteHostnameRewriteProperty.DefaultTargetHostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html#cfn-appmesh-gatewayroute-gatewayroutehostnamerewrite-defaulttargethostname

Return type

Optional[str]

GatewayRouteMetadataMatchProperty

class CfnGatewayRoute.GatewayRouteMetadataMatchProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Exact.

  • prefix (Optional[str]) – CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Prefix.

  • range (Union[IResolvable, GatewayRouteRangeMatchProperty, None]) – CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Range.

  • regex (Optional[str]) – CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Regex.

  • suffix (Optional[str]) – CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html

Attributes

exact

CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-exact

Return type

Optional[str]

prefix

CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-prefix

Return type

Optional[str]

range

CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Range.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-range

Return type

Union[IResolvable, GatewayRouteRangeMatchProperty, None]

regex

CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Regex.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-regex

Return type

Optional[str]

suffix

CfnGatewayRoute.GatewayRouteMetadataMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-suffix

Return type

Optional[str]

GatewayRouteRangeMatchProperty

class CfnGatewayRoute.GatewayRouteRangeMatchProperty(*, end, start)

Bases: object

Parameters
  • end (Union[int, float]) – CfnGatewayRoute.GatewayRouteRangeMatchProperty.End.

  • start (Union[int, float]) – CfnGatewayRoute.GatewayRouteRangeMatchProperty.Start.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html

Attributes

end

CfnGatewayRoute.GatewayRouteRangeMatchProperty.End.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-end

Return type

Union[int, float]

start

CfnGatewayRoute.GatewayRouteRangeMatchProperty.Start.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-start

Return type

Union[int, float]

GatewayRouteSpecProperty

class CfnGatewayRoute.GatewayRouteSpecProperty(*, grpc_route=None, http2_route=None, http_route=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html

Attributes

grpc_route

CfnGatewayRoute.GatewayRouteSpecProperty.GrpcRoute.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-grpcroute

Return type

Union[IResolvable, GrpcGatewayRouteProperty, None]

http2_route

CfnGatewayRoute.GatewayRouteSpecProperty.Http2Route.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-http2route

Return type

Union[HttpGatewayRouteProperty, IResolvable, None]

http_route

CfnGatewayRoute.GatewayRouteSpecProperty.HttpRoute.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-httproute

Return type

Union[HttpGatewayRouteProperty, IResolvable, None]

GatewayRouteTargetProperty

class CfnGatewayRoute.GatewayRouteTargetProperty(*, virtual_service)

Bases: object

Parameters

virtual_service (Union[IResolvable, GatewayRouteVirtualServiceProperty]) – CfnGatewayRoute.GatewayRouteTargetProperty.VirtualService.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html

Attributes

virtual_service

CfnGatewayRoute.GatewayRouteTargetProperty.VirtualService.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-virtualservice

Return type

Union[IResolvable, GatewayRouteVirtualServiceProperty]

GatewayRouteVirtualServiceProperty

class CfnGatewayRoute.GatewayRouteVirtualServiceProperty(*, virtual_service_name)

Bases: object

Parameters

virtual_service_name (str) – CfnGatewayRoute.GatewayRouteVirtualServiceProperty.VirtualServiceName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html

Attributes

virtual_service_name

CfnGatewayRoute.GatewayRouteVirtualServiceProperty.VirtualServiceName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html#cfn-appmesh-gatewayroute-gatewayroutevirtualservice-virtualservicename

Return type

str

GrpcGatewayRouteActionProperty

class CfnGatewayRoute.GrpcGatewayRouteActionProperty(*, target, rewrite=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html

Attributes

rewrite

CfnGatewayRoute.GrpcGatewayRouteActionProperty.Rewrite.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-rewrite

Return type

Union[IResolvable, GrpcGatewayRouteRewriteProperty, None]

target

CfnGatewayRoute.GrpcGatewayRouteActionProperty.Target.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-target

Return type

Union[IResolvable, GatewayRouteTargetProperty]

GrpcGatewayRouteMatchProperty

class CfnGatewayRoute.GrpcGatewayRouteMatchProperty(*, hostname=None, metadata=None, service_name=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html

Attributes

hostname

CfnGatewayRoute.GrpcGatewayRouteMatchProperty.Hostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-hostname

Return type

Union[GatewayRouteHostnameMatchProperty, IResolvable, None]

metadata

CfnGatewayRoute.GrpcGatewayRouteMatchProperty.Metadata.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-metadata

Return type

Union[IResolvable, List[Union[IResolvable, GrpcGatewayRouteMetadataProperty]], None]

service_name

CfnGatewayRoute.GrpcGatewayRouteMatchProperty.ServiceName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-servicename

Return type

Optional[str]

GrpcGatewayRouteMetadataProperty

class CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(*, name, invert=None, match=None)

Bases: object

Parameters
  • name (str) – CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Name.

  • invert (Union[bool, IResolvable, None]) – CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Invert.

  • match (Union[IResolvable, GatewayRouteMetadataMatchProperty, None]) – CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html

Attributes

invert

CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Invert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-invert

Return type

Union[bool, IResolvable, None]

match

CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-match

Return type

Union[IResolvable, GatewayRouteMetadataMatchProperty, None]

name

CfnGatewayRoute.GrpcGatewayRouteMetadataProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-name

Return type

str

GrpcGatewayRouteProperty

class CfnGatewayRoute.GrpcGatewayRouteProperty(*, action, match)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html

Attributes

action

CfnGatewayRoute.GrpcGatewayRouteProperty.Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-action

Return type

Union[IResolvable, GrpcGatewayRouteActionProperty]

match

CfnGatewayRoute.GrpcGatewayRouteProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-match

Return type

Union[IResolvable, GrpcGatewayRouteMatchProperty]

GrpcGatewayRouteRewriteProperty

class CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(*, hostname=None)

Bases: object

Parameters

hostname (Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]) – CfnGatewayRoute.GrpcGatewayRouteRewriteProperty.Hostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html

Attributes

hostname

CfnGatewayRoute.GrpcGatewayRouteRewriteProperty.Hostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html#cfn-appmesh-gatewayroute-grpcgatewayrouterewrite-hostname

Return type

Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]

HttpGatewayRouteActionProperty

class CfnGatewayRoute.HttpGatewayRouteActionProperty(*, target, rewrite=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html

Attributes

rewrite

CfnGatewayRoute.HttpGatewayRouteActionProperty.Rewrite.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-rewrite

Return type

Union[IResolvable, HttpGatewayRouteRewriteProperty, None]

target

CfnGatewayRoute.HttpGatewayRouteActionProperty.Target.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-target

Return type

Union[IResolvable, GatewayRouteTargetProperty]

HttpGatewayRouteHeaderMatchProperty

class CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Exact.

  • prefix (Optional[str]) – CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Prefix.

  • range (Union[IResolvable, GatewayRouteRangeMatchProperty, None]) – CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Range.

  • regex (Optional[str]) – CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Regex.

  • suffix (Optional[str]) – CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html

Attributes

exact

CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-exact

Return type

Optional[str]

prefix

CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-prefix

Return type

Optional[str]

range

CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Range.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-range

Return type

Union[IResolvable, GatewayRouteRangeMatchProperty, None]

regex

CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Regex.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-regex

Return type

Optional[str]

suffix

CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty.Suffix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-suffix

Return type

Optional[str]

HttpGatewayRouteHeaderProperty

class CfnGatewayRoute.HttpGatewayRouteHeaderProperty(*, name, invert=None, match=None)

Bases: object

Parameters
  • name (str) – CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Name.

  • invert (Union[bool, IResolvable, None]) – CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Invert.

  • match (Union[IResolvable, HttpGatewayRouteHeaderMatchProperty, None]) – CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html

Attributes

invert

CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Invert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-invert

Return type

Union[bool, IResolvable, None]

match

CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-match

Return type

Union[IResolvable, HttpGatewayRouteHeaderMatchProperty, None]

name

CfnGatewayRoute.HttpGatewayRouteHeaderProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-name

Return type

str

HttpGatewayRouteMatchProperty

class CfnGatewayRoute.HttpGatewayRouteMatchProperty(*, headers=None, hostname=None, method=None, path=None, prefix=None, query_parameters=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html

Attributes

headers

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Headers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers

Return type

Union[IResolvable, List[Union[IResolvable, HttpGatewayRouteHeaderProperty]], None]

hostname

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Hostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname

Return type

Union[GatewayRouteHostnameMatchProperty, IResolvable, None]

method

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Method.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method

Return type

Optional[str]

path

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Path.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path

Return type

Union[HttpPathMatchProperty, IResolvable, None]

prefix

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix

Return type

Optional[str]

query_parameters

CfnGatewayRoute.HttpGatewayRouteMatchProperty.QueryParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters

Return type

Union[IResolvable, List[Union[IResolvable, QueryParameterProperty]], None]

HttpGatewayRoutePathRewriteProperty

class CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(*, exact=None)

Bases: object

Parameters

exact (Optional[str]) – CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html

Attributes

exact

CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html#cfn-appmesh-gatewayroute-httpgatewayroutepathrewrite-exact

Return type

Optional[str]

HttpGatewayRoutePrefixRewriteProperty

class CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(*, default_prefix=None, value=None)

Bases: object

Parameters
  • default_prefix (Optional[str]) – CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty.DefaultPrefix.

  • value (Optional[str]) – CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html

Attributes

default_prefix

CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty.DefaultPrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-defaultprefix

Return type

Optional[str]

value

CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-value

Return type

Optional[str]

HttpGatewayRouteProperty

class CfnGatewayRoute.HttpGatewayRouteProperty(*, action, match)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html

Attributes

action

CfnGatewayRoute.HttpGatewayRouteProperty.Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-action

Return type

Union[IResolvable, HttpGatewayRouteActionProperty]

match

CfnGatewayRoute.HttpGatewayRouteProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-match

Return type

Union[IResolvable, HttpGatewayRouteMatchProperty]

HttpGatewayRouteRewriteProperty

class CfnGatewayRoute.HttpGatewayRouteRewriteProperty(*, hostname=None, path=None, prefix=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html

Attributes

hostname

CfnGatewayRoute.HttpGatewayRouteRewriteProperty.Hostname.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-hostname

Return type

Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]

path

CfnGatewayRoute.HttpGatewayRouteRewriteProperty.Path.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-path

Return type

Union[IResolvable, HttpGatewayRoutePathRewriteProperty, None]

prefix

CfnGatewayRoute.HttpGatewayRouteRewriteProperty.Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-prefix

Return type

Union[IResolvable, HttpGatewayRoutePrefixRewriteProperty, None]

HttpPathMatchProperty

class CfnGatewayRoute.HttpPathMatchProperty(*, exact=None, regex=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnGatewayRoute.HttpPathMatchProperty.Exact.

  • regex (Optional[str]) – CfnGatewayRoute.HttpPathMatchProperty.Regex.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html

Attributes

exact

CfnGatewayRoute.HttpPathMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-exact

Return type

Optional[str]

regex

CfnGatewayRoute.HttpPathMatchProperty.Regex.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-regex

Return type

Optional[str]

HttpQueryParameterMatchProperty

class CfnGatewayRoute.HttpQueryParameterMatchProperty(*, exact=None)

Bases: object

Parameters

exact (Optional[str]) – CfnGatewayRoute.HttpQueryParameterMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html

Attributes

exact

CfnGatewayRoute.HttpQueryParameterMatchProperty.Exact.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html#cfn-appmesh-gatewayroute-httpqueryparametermatch-exact

Return type

Optional[str]

QueryParameterProperty

class CfnGatewayRoute.QueryParameterProperty(*, name, match=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html

Attributes

match

CfnGatewayRoute.QueryParameterProperty.Match.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-match

Return type

Union[IResolvable, HttpQueryParameterMatchProperty, None]

name

CfnGatewayRoute.QueryParameterProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-name

Return type

str