CfnVirtualRouter¶
-
class
aws_cdk.aws_appmesh.
CfnVirtualRouter
(scope, id, *, mesh_name, spec, mesh_owner=None, tags=None, virtual_router_name=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::AppMesh::VirtualRouter
.Creates a virtual router within a service mesh.
Specify a
listener
for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.For more information about virtual routers, see Virtual routers .
- CloudformationResource
AWS::AppMesh::VirtualRouter
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appmesh as appmesh cfn_virtual_router = appmesh.CfnVirtualRouter(self, "MyCfnVirtualRouter", mesh_name="meshName", spec=appmesh.CfnVirtualRouter.VirtualRouterSpecProperty( listeners=[appmesh.CfnVirtualRouter.VirtualRouterListenerProperty( port_mapping=appmesh.CfnVirtualRouter.PortMappingProperty( port=123, protocol="protocol" ) )] ), # the properties below are optional mesh_owner="meshOwner", tags=[CfnTag( key="key", value="value" )], virtual_router_name="virtualRouterName" )
Create a new
AWS::AppMesh::VirtualRouter
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
mesh_name (
str
) – The name of the service mesh to create the virtual router in.spec (
Union
[IResolvable
,VirtualRouterSpecProperty
,Dict
[str
,Any
]]) – The virtual router specification to apply.mesh_owner (
Optional
[str
]) – The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.virtual_router_name (
Optional
[str
]) – The name to use for the virtual router.
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 prefixpath
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:
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" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- 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: truedefault (
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
-
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::VirtualRouter'¶
-
attr_arn
¶ The full Amazon Resource Name (ARN) for the virtual router.
- CloudformationAttribute
Arn
- Return type
str
-
attr_mesh_name
¶ The name of the service mesh that the virtual router resides in.
- CloudformationAttribute
MeshName
- Return type
str
-
attr_mesh_owner
¶ The AWS IAM account ID of the service mesh owner.
If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .
- CloudformationAttribute
MeshOwner
- Return type
str
-
attr_resource_owner
¶ The AWS IAM account ID of the resource owner.
If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .
- CloudformationAttribute
ResourceOwner
- Return type
str
-
attr_uid
¶ The unique identifier for the virtual router.
- CloudformationAttribute
Uid
- Return type
str
-
attr_virtual_router_name
¶ The name of the virtual router.
- CloudformationAttribute
VirtualRouterName
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
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
¶ The name of the service mesh to create the virtual router in.
-
mesh_owner
¶ The AWS IAM account ID of the service mesh owner.
If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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
¶ The virtual router specification to apply.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Optional metadata that you can apply to the virtual router to assist with categorization and organization.
Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
-
virtual_router_name
¶ The name to use for the virtual router.
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
PortMappingProperty¶
-
class
CfnVirtualRouter.
PortMappingProperty
(*, port, protocol)¶ Bases:
object
An object representing a virtual router listener port mapping.
- Parameters
port (
Union
[int
,float
]) – The port used for the port mapping.protocol (
str
) – The protocol used for the port mapping. Specify one protocol.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appmesh as appmesh port_mapping_property = appmesh.CfnVirtualRouter.PortMappingProperty( port=123, protocol="protocol" )
Attributes
-
port
¶ The port used for the port mapping.
-
protocol
¶ The protocol used for the port mapping.
Specify one protocol.
VirtualRouterListenerProperty¶
-
class
CfnVirtualRouter.
VirtualRouterListenerProperty
(*, port_mapping)¶ Bases:
object
An object that represents a virtual router listener.
- Parameters
port_mapping (
Union
[IResolvable
,PortMappingProperty
,Dict
[str
,Any
]]) – The port mapping information for the listener.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appmesh as appmesh virtual_router_listener_property = appmesh.CfnVirtualRouter.VirtualRouterListenerProperty( port_mapping=appmesh.CfnVirtualRouter.PortMappingProperty( port=123, protocol="protocol" ) )
Attributes
-
port_mapping
¶ The port mapping information for the listener.
VirtualRouterSpecProperty¶
-
class
CfnVirtualRouter.
VirtualRouterSpecProperty
(*, listeners)¶ Bases:
object
An object that represents the specification of a virtual router.
- Parameters
listeners (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,VirtualRouterListenerProperty
,Dict
[str
,Any
]]]]) – The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appmesh as appmesh virtual_router_spec_property = appmesh.CfnVirtualRouter.VirtualRouterSpecProperty( listeners=[appmesh.CfnVirtualRouter.VirtualRouterListenerProperty( port_mapping=appmesh.CfnVirtualRouter.PortMappingProperty( port=123, protocol="protocol" ) )] )
Attributes
-
listeners
¶ The listeners that the virtual router is expected to receive inbound traffic from.
You can specify one listener.