CfnRoute

class aws_cdk.aws_appmesh.CfnRoute(scope, id, *, mesh_name, route_name, spec, virtual_router_name, mesh_owner=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AppMesh::Route.

See

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

CloudformationResource

AWS::AppMesh::Route

Create a new AWS::AppMesh::Route.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

  • route_name (str) – AWS::AppMesh::Route.RouteName.

  • spec (Union[IResolvable, RouteSpecProperty]) – AWS::AppMesh::Route.Spec.

  • virtual_router_name (str) – AWS::AppMesh::Route.VirtualRouterName.

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

  • tags (Optional[List[CfnTag]]) – AWS::AppMesh::Route.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 without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
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.

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)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

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::Route'
attr_arn

Arn

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_route_name

RouteName

Type

cloudformationAttribute

Return type

str

attr_uid

Uid

Type

cloudformationAttribute

Return type

str

attr_virtual_router_name

VirtualRouterName

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]

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::Route.MeshName.

See

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

Return type

str

mesh_owner

AWS::AppMesh::Route.MeshOwner.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html#cfn-appmesh-route-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

route_name

AWS::AppMesh::Route.RouteName.

See

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

Return type

str

spec

AWS::AppMesh::Route.Spec.

See

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

Return type

Union[IResolvable, RouteSpecProperty]

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::Route.Tags.

See

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

Return type

TagManager

virtual_router_name

AWS::AppMesh::Route.VirtualRouterName.

See

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

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

DurationProperty

class CfnRoute.DurationProperty(*, unit, value)

Bases: object

Parameters
  • unit (str) – CfnRoute.DurationProperty.Unit.

  • value (Union[int, float]) – CfnRoute.DurationProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html

Attributes

unit

CfnRoute.DurationProperty.Unit.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html#cfn-appmesh-route-duration-unit

Return type

str

value

CfnRoute.DurationProperty.Value.

See

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

Return type

Union[int, float]

GrpcRetryPolicyProperty

class CfnRoute.GrpcRetryPolicyProperty(*, max_retries, per_retry_timeout, grpc_retry_events=None, http_retry_events=None, tcp_retry_events=None)

Bases: object

Parameters
  • max_retries (Union[int, float]) – CfnRoute.GrpcRetryPolicyProperty.MaxRetries.

  • per_retry_timeout (Union[IResolvable, DurationProperty]) – CfnRoute.GrpcRetryPolicyProperty.PerRetryTimeout.

  • grpc_retry_events (Optional[List[str]]) – CfnRoute.GrpcRetryPolicyProperty.GrpcRetryEvents.

  • http_retry_events (Optional[List[str]]) – CfnRoute.GrpcRetryPolicyProperty.HttpRetryEvents.

  • tcp_retry_events (Optional[List[str]]) – CfnRoute.GrpcRetryPolicyProperty.TcpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html

Attributes

grpc_retry_events

CfnRoute.GrpcRetryPolicyProperty.GrpcRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-grpcretryevents

Return type

Optional[List[str]]

http_retry_events

CfnRoute.GrpcRetryPolicyProperty.HttpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-httpretryevents

Return type

Optional[List[str]]

max_retries

CfnRoute.GrpcRetryPolicyProperty.MaxRetries.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-maxretries

Return type

Union[int, float]

per_retry_timeout

CfnRoute.GrpcRetryPolicyProperty.PerRetryTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-perretrytimeout

Return type

Union[IResolvable, DurationProperty]

tcp_retry_events

CfnRoute.GrpcRetryPolicyProperty.TcpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcretrypolicy.html#cfn-appmesh-route-grpcretrypolicy-tcpretryevents

Return type

Optional[List[str]]

GrpcRouteActionProperty

class CfnRoute.GrpcRouteActionProperty(*, weighted_targets)

Bases: object

Parameters

weighted_targets (Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]) – CfnRoute.GrpcRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html

Attributes

weighted_targets

CfnRoute.GrpcRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcrouteaction.html#cfn-appmesh-route-grpcrouteaction-weightedtargets

Return type

Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]

GrpcRouteMatchProperty

class CfnRoute.GrpcRouteMatchProperty(*, metadata=None, method_name=None, service_name=None)

Bases: object

Parameters
  • metadata (Union[IResolvable, List[Union[IResolvable, GrpcRouteMetadataProperty]], None]) – CfnRoute.GrpcRouteMatchProperty.Metadata.

  • method_name (Optional[str]) – CfnRoute.GrpcRouteMatchProperty.MethodName.

  • service_name (Optional[str]) – CfnRoute.GrpcRouteMatchProperty.ServiceName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html

Attributes

metadata

CfnRoute.GrpcRouteMatchProperty.Metadata.

See

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

Return type

Union[IResolvable, List[Union[IResolvable, GrpcRouteMetadataProperty]], None]

method_name

CfnRoute.GrpcRouteMatchProperty.MethodName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutematch.html#cfn-appmesh-route-grpcroutematch-methodname

Return type

Optional[str]

service_name

CfnRoute.GrpcRouteMatchProperty.ServiceName.

See

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

Return type

Optional[str]

GrpcRouteMetadataMatchMethodProperty

class CfnRoute.GrpcRouteMetadataMatchMethodProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnRoute.GrpcRouteMetadataMatchMethodProperty.Exact.

  • prefix (Optional[str]) – CfnRoute.GrpcRouteMetadataMatchMethodProperty.Prefix.

  • range (Union[IResolvable, MatchRangeProperty, None]) – CfnRoute.GrpcRouteMetadataMatchMethodProperty.Range.

  • regex (Optional[str]) – CfnRoute.GrpcRouteMetadataMatchMethodProperty.Regex.

  • suffix (Optional[str]) – CfnRoute.GrpcRouteMetadataMatchMethodProperty.Suffix.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadatamatchmethod.html

Attributes

exact

CfnRoute.GrpcRouteMetadataMatchMethodProperty.Exact.

See

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

Return type

Optional[str]

prefix

CfnRoute.GrpcRouteMetadataMatchMethodProperty.Prefix.

See

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

Return type

Optional[str]

range

CfnRoute.GrpcRouteMetadataMatchMethodProperty.Range.

See

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

Return type

Union[IResolvable, MatchRangeProperty, None]

regex

CfnRoute.GrpcRouteMetadataMatchMethodProperty.Regex.

See

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

Return type

Optional[str]

suffix

CfnRoute.GrpcRouteMetadataMatchMethodProperty.Suffix.

See

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

Return type

Optional[str]

GrpcRouteMetadataProperty

class CfnRoute.GrpcRouteMetadataProperty(*, name, invert=None, match=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html

Attributes

invert

CfnRoute.GrpcRouteMetadataProperty.Invert.

See

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

Return type

Union[bool, IResolvable, None]

match

CfnRoute.GrpcRouteMetadataProperty.Match.

See

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

Return type

Union[IResolvable, GrpcRouteMetadataMatchMethodProperty, None]

name

CfnRoute.GrpcRouteMetadataProperty.Name.

See

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

Return type

str

GrpcRouteProperty

class CfnRoute.GrpcRouteProperty(*, action, match, retry_policy=None, timeout=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroute.html

Attributes

action

CfnRoute.GrpcRouteProperty.Action.

See

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

Return type

Union[IResolvable, GrpcRouteActionProperty]

match

CfnRoute.GrpcRouteProperty.Match.

See

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

Return type

Union[IResolvable, GrpcRouteMatchProperty]

retry_policy

CfnRoute.GrpcRouteProperty.RetryPolicy.

See

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

Return type

Union[IResolvable, GrpcRetryPolicyProperty, None]

timeout

CfnRoute.GrpcRouteProperty.Timeout.

See

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

Return type

Union[IResolvable, GrpcTimeoutProperty, None]

GrpcTimeoutProperty

class CfnRoute.GrpcTimeoutProperty(*, idle=None, per_request=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html

Attributes

idle

CfnRoute.GrpcTimeoutProperty.Idle.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html#cfn-appmesh-route-grpctimeout-idle

Return type

Union[IResolvable, DurationProperty, None]

per_request

CfnRoute.GrpcTimeoutProperty.PerRequest.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpctimeout.html#cfn-appmesh-route-grpctimeout-perrequest

Return type

Union[IResolvable, DurationProperty, None]

HeaderMatchMethodProperty

class CfnRoute.HeaderMatchMethodProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

Parameters
  • exact (Optional[str]) – CfnRoute.HeaderMatchMethodProperty.Exact.

  • prefix (Optional[str]) – CfnRoute.HeaderMatchMethodProperty.Prefix.

  • range (Union[IResolvable, MatchRangeProperty, None]) – CfnRoute.HeaderMatchMethodProperty.Range.

  • regex (Optional[str]) – CfnRoute.HeaderMatchMethodProperty.Regex.

  • suffix (Optional[str]) – CfnRoute.HeaderMatchMethodProperty.Suffix.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-headermatchmethod.html

Attributes

exact

CfnRoute.HeaderMatchMethodProperty.Exact.

See

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

Return type

Optional[str]

prefix

CfnRoute.HeaderMatchMethodProperty.Prefix.

See

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

Return type

Optional[str]

range

CfnRoute.HeaderMatchMethodProperty.Range.

See

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

Return type

Union[IResolvable, MatchRangeProperty, None]

regex

CfnRoute.HeaderMatchMethodProperty.Regex.

See

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

Return type

Optional[str]

suffix

CfnRoute.HeaderMatchMethodProperty.Suffix.

See

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

Return type

Optional[str]

HttpRetryPolicyProperty

class CfnRoute.HttpRetryPolicyProperty(*, max_retries, per_retry_timeout, http_retry_events=None, tcp_retry_events=None)

Bases: object

Parameters
  • max_retries (Union[int, float]) – CfnRoute.HttpRetryPolicyProperty.MaxRetries.

  • per_retry_timeout (Union[IResolvable, DurationProperty]) – CfnRoute.HttpRetryPolicyProperty.PerRetryTimeout.

  • http_retry_events (Optional[List[str]]) – CfnRoute.HttpRetryPolicyProperty.HttpRetryEvents.

  • tcp_retry_events (Optional[List[str]]) – CfnRoute.HttpRetryPolicyProperty.TcpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html

Attributes

http_retry_events

CfnRoute.HttpRetryPolicyProperty.HttpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-httpretryevents

Return type

Optional[List[str]]

max_retries

CfnRoute.HttpRetryPolicyProperty.MaxRetries.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-maxretries

Return type

Union[int, float]

per_retry_timeout

CfnRoute.HttpRetryPolicyProperty.PerRetryTimeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-perretrytimeout

Return type

Union[IResolvable, DurationProperty]

tcp_retry_events

CfnRoute.HttpRetryPolicyProperty.TcpRetryEvents.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httpretrypolicy.html#cfn-appmesh-route-httpretrypolicy-tcpretryevents

Return type

Optional[List[str]]

HttpRouteActionProperty

class CfnRoute.HttpRouteActionProperty(*, weighted_targets)

Bases: object

Parameters

weighted_targets (Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]) – CfnRoute.HttpRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html

Attributes

weighted_targets

CfnRoute.HttpRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteaction.html#cfn-appmesh-route-httprouteaction-weightedtargets

Return type

Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]

HttpRouteHeaderProperty

class CfnRoute.HttpRouteHeaderProperty(*, name, invert=None, match=None)

Bases: object

Parameters
  • name (str) – CfnRoute.HttpRouteHeaderProperty.Name.

  • invert (Union[bool, IResolvable, None]) – CfnRoute.HttpRouteHeaderProperty.Invert.

  • match (Union[IResolvable, HeaderMatchMethodProperty, None]) – CfnRoute.HttpRouteHeaderProperty.Match.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html

Attributes

invert

CfnRoute.HttpRouteHeaderProperty.Invert.

See

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

Return type

Union[bool, IResolvable, None]

match

CfnRoute.HttpRouteHeaderProperty.Match.

See

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

Return type

Union[IResolvable, HeaderMatchMethodProperty, None]

name

CfnRoute.HttpRouteHeaderProperty.Name.

See

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

Return type

str

HttpRouteMatchProperty

class CfnRoute.HttpRouteMatchProperty(*, prefix, headers=None, method=None, scheme=None)

Bases: object

Parameters
  • prefix (str) – CfnRoute.HttpRouteMatchProperty.Prefix.

  • headers (Union[IResolvable, List[Union[IResolvable, HttpRouteHeaderProperty]], None]) – CfnRoute.HttpRouteMatchProperty.Headers.

  • method (Optional[str]) – CfnRoute.HttpRouteMatchProperty.Method.

  • scheme (Optional[str]) – CfnRoute.HttpRouteMatchProperty.Scheme.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html

Attributes

headers

CfnRoute.HttpRouteMatchProperty.Headers.

See

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

Return type

Union[IResolvable, List[Union[IResolvable, HttpRouteHeaderProperty]], None]

method

CfnRoute.HttpRouteMatchProperty.Method.

See

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

Return type

Optional[str]

prefix

CfnRoute.HttpRouteMatchProperty.Prefix.

See

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

Return type

str

scheme

CfnRoute.HttpRouteMatchProperty.Scheme.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-scheme

Return type

Optional[str]

HttpRouteProperty

class CfnRoute.HttpRouteProperty(*, action, match, retry_policy=None, timeout=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproute.html

Attributes

action

CfnRoute.HttpRouteProperty.Action.

See

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

Return type

Union[IResolvable, HttpRouteActionProperty]

match

CfnRoute.HttpRouteProperty.Match.

See

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

Return type

Union[IResolvable, HttpRouteMatchProperty]

retry_policy

CfnRoute.HttpRouteProperty.RetryPolicy.

See

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

Return type

Union[IResolvable, HttpRetryPolicyProperty, None]

timeout

CfnRoute.HttpRouteProperty.Timeout.

See

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

Return type

Union[IResolvable, HttpTimeoutProperty, None]

HttpTimeoutProperty

class CfnRoute.HttpTimeoutProperty(*, idle=None, per_request=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html

Attributes

idle

CfnRoute.HttpTimeoutProperty.Idle.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html#cfn-appmesh-route-httptimeout-idle

Return type

Union[IResolvable, DurationProperty, None]

per_request

CfnRoute.HttpTimeoutProperty.PerRequest.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httptimeout.html#cfn-appmesh-route-httptimeout-perrequest

Return type

Union[IResolvable, DurationProperty, None]

MatchRangeProperty

class CfnRoute.MatchRangeProperty(*, end, start)

Bases: object

Parameters
  • end (Union[int, float]) – CfnRoute.MatchRangeProperty.End.

  • start (Union[int, float]) – CfnRoute.MatchRangeProperty.Start.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-matchrange.html

Attributes

end

CfnRoute.MatchRangeProperty.End.

See

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

Return type

Union[int, float]

start

CfnRoute.MatchRangeProperty.Start.

See

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

Return type

Union[int, float]

RouteSpecProperty

class CfnRoute.RouteSpecProperty(*, grpc_route=None, http2_route=None, http_route=None, priority=None, tcp_route=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html

Attributes

grpc_route

CfnRoute.RouteSpecProperty.GrpcRoute.

See

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

Return type

Union[IResolvable, GrpcRouteProperty, None]

http2_route

CfnRoute.RouteSpecProperty.Http2Route.

See

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

Return type

Union[HttpRouteProperty, IResolvable, None]

http_route

CfnRoute.RouteSpecProperty.HttpRoute.

See

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

Return type

Union[HttpRouteProperty, IResolvable, None]

priority

CfnRoute.RouteSpecProperty.Priority.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-priority

Return type

Union[int, float, None]

tcp_route

CfnRoute.RouteSpecProperty.TcpRoute.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-tcproute

Return type

Union[IResolvable, TcpRouteProperty, None]

TcpRouteActionProperty

class CfnRoute.TcpRouteActionProperty(*, weighted_targets)

Bases: object

Parameters

weighted_targets (Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]) – CfnRoute.TcpRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html

Attributes

weighted_targets

CfnRoute.TcpRouteActionProperty.WeightedTargets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html#cfn-appmesh-route-tcprouteaction-weightedtargets

Return type

Union[IResolvable, List[Union[IResolvable, WeightedTargetProperty]]]

TcpRouteProperty

class CfnRoute.TcpRouteProperty(*, action, timeout=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html

Attributes

action

CfnRoute.TcpRouteProperty.Action.

See

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

Return type

Union[IResolvable, TcpRouteActionProperty]

timeout

CfnRoute.TcpRouteProperty.Timeout.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproute.html#cfn-appmesh-route-tcproute-timeout

Return type

Union[IResolvable, TcpTimeoutProperty, None]

TcpTimeoutProperty

class CfnRoute.TcpTimeoutProperty(*, idle=None)

Bases: object

Parameters

idle (Union[IResolvable, DurationProperty, None]) – CfnRoute.TcpTimeoutProperty.Idle.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcptimeout.html

Attributes

idle

CfnRoute.TcpTimeoutProperty.Idle.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcptimeout.html#cfn-appmesh-route-tcptimeout-idle

Return type

Union[IResolvable, DurationProperty, None]

WeightedTargetProperty

class CfnRoute.WeightedTargetProperty(*, virtual_node, weight)

Bases: object

Parameters
  • virtual_node (str) – CfnRoute.WeightedTargetProperty.VirtualNode.

  • weight (Union[int, float]) – CfnRoute.WeightedTargetProperty.Weight.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html

Attributes

virtual_node

CfnRoute.WeightedTargetProperty.VirtualNode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-virtualnode

Return type

str

weight

CfnRoute.WeightedTargetProperty.Weight.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html#cfn-appmesh-route-weightedtarget-weight

Return type

Union[int, float]