Package software.amazon.awscdk.services.appmesh

Interface CfnVirtualServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVirtualServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:11.162Z")
@Stability(Stable)
public interface CfnVirtualServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVirtualService.

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.*;
 CfnVirtualServiceProps cfnVirtualServiceProps = CfnVirtualServiceProps.builder()
         .meshName("meshName")
         .spec(VirtualServiceSpecProperty.builder()
                 .provider(VirtualServiceProviderProperty.builder()
                         .virtualNode(VirtualNodeServiceProviderProperty.builder()
                                 .virtualNodeName("virtualNodeName")
                                 .build())
                         .virtualRouter(VirtualRouterServiceProviderProperty.builder()
                                 .virtualRouterName("virtualRouterName")
                                 .build())
                         .build())
                 .build())
         .virtualServiceName("virtualServiceName")
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

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 service in.

See Also:

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

getSpec

@Stability(Stable)
@NotNull
Object getSpec()

The virtual service specification to apply.

See Also:

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

getVirtualServiceName

@Stability(Stable)
@NotNull
String getVirtualServiceName()

The name to use for the virtual service.

See Also:

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

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-virtualservice.html#cfn-appmesh-virtualservice-meshowner

getTags

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

Optional metadata that you can apply to the virtual service 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-virtualservice.html#cfn-appmesh-virtualservice-tags

builder

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

Returns:

a CfnVirtualServiceProps.Builder of CfnVirtualServiceProps