Package software.amazon.awscdk.services.appmesh

Interface CfnVirtualRouterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVirtualRouterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.662Z")
@Stability(Stable)
public interface CfnVirtualRouterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVirtualRouter.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 CfnVirtualRouterProps cfnVirtualRouterProps = CfnVirtualRouterProps.builder()
         .meshName("meshName")
         .spec(VirtualRouterSpecProperty.builder()
                 .listeners(List.of(VirtualRouterListenerProperty.builder()
                         .portMapping(PortMappingProperty.builder()
                                 .port(123)
                                 .protocol("protocol")
                                 .build())
                         .build()))
                 .build())
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualRouterName("virtualRouterName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVirtualRouterProps.Builder	A builder for CfnVirtualRouterProps
static final class	CfnVirtualRouterProps.Jsii$Proxy	An implementation for CfnVirtualRouterProps

Method Summary

Modifier and Type	Method	Description
static CfnVirtualRouterProps.Builder	builder()
String	getMeshName()	The name of the service mesh to create the virtual router in.
default String	getMeshOwner()	The AWS IAM account ID of the service mesh owner.
Object	getSpec()	The virtual router specification to apply.
default List<CfnTag>	getTags()	Optional metadata that you can apply to the virtual router to assist with categorization and organization.
default String	getVirtualRouterName()	The name to use for the virtual router.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMeshName

@Stability(Stable)
@NotNull
String getMeshName()

The name of the service mesh to create the virtual router in.

See Also:

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

getSpec

@Stability(Stable)
@NotNull
Object getSpec()

The virtual router specification to apply.

See Also:

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

getMeshOwner

@Stability(Stable)
@Nullable
default String getMeshOwner()

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

getVirtualRouterName

@Stability(Stable)
@Nullable
default String getVirtualRouterName()

The name to use for the virtual router.

See Also:

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

builder

@Stability(Stable)
static CfnVirtualRouterProps.Builder builder()

Returns:

a CfnVirtualRouterProps.Builder of CfnVirtualRouterProps