Package software.amazon.awscdk.services.appmesh

Interface CfnVirtualNodeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnVirtualNodeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.008Z") @Stability(Stable) public interface CfnVirtualNodeProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnVirtualNode.

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.*;
 CfnVirtualNodeProps cfnVirtualNodeProps = CfnVirtualNodeProps.builder()
         .meshName("meshName")
         .spec(VirtualNodeSpecProperty.builder()
                 .backendDefaults(BackendDefaultsProperty.builder()
                         .clientPolicy(ClientPolicyProperty.builder()
                                 .tls(ClientPolicyTlsProperty.builder()
                                         .validation(TlsValidationContextProperty.builder()
                                                 .trust(TlsValidationContextTrustProperty.builder()
                                                         .acm(TlsValidationContextAcmTrustProperty.builder()
                                                                 .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                 .build())
                                                         .file(TlsValidationContextFileTrustProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .build())
                                                         .sds(TlsValidationContextSdsTrustProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 // the properties below are optional
                                                 .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                         .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                 .exact(List.of("exact"))
                                                                 .build())
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .certificate(ClientTlsCertificateProperty.builder()
                                                 .file(ListenerTlsFileCertificateProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .privateKey("privateKey")
                                                         .build())
                                                 .sds(ListenerTlsSdsCertificateProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .enforce(false)
                                         .ports(List.of(123))
                                         .build())
                                 .build())
                         .build())
                 .backends(List.of(BackendProperty.builder()
                         .virtualService(VirtualServiceBackendProperty.builder()
                                 .virtualServiceName("virtualServiceName")
                                 // the properties below are optional
                                 .clientPolicy(ClientPolicyProperty.builder()
                                         .tls(ClientPolicyTlsProperty.builder()
                                                 .validation(TlsValidationContextProperty.builder()
                                                         .trust(TlsValidationContextTrustProperty.builder()
                                                                 .acm(TlsValidationContextAcmTrustProperty.builder()
                                                                         .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                         .build())
                                                                 .file(TlsValidationContextFileTrustProperty.builder()
                                                                         .certificateChain("certificateChain")
                                                                         .build())
                                                                 .sds(TlsValidationContextSdsTrustProperty.builder()
                                                                         .secretName("secretName")
                                                                         .build())
                                                                 .build())
                                                         // the properties below are optional
                                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                         .exact(List.of("exact"))
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 // the properties below are optional
                                                 .certificate(ClientTlsCertificateProperty.builder()
                                                         .file(ListenerTlsFileCertificateProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .privateKey("privateKey")
                                                                 .build())
                                                         .sds(ListenerTlsSdsCertificateProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 .enforce(false)
                                                 .ports(List.of(123))
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 .listeners(List.of(ListenerProperty.builder()
                         .portMapping(PortMappingProperty.builder()
                                 .port(123)
                                 .protocol("protocol")
                                 .build())
                         // the properties below are optional
                         .connectionPool(VirtualNodeConnectionPoolProperty.builder()
                                 .grpc(VirtualNodeGrpcConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .http(VirtualNodeHttpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         // the properties below are optional
                                         .maxPendingRequests(123)
                                         .build())
                                 .http2(VirtualNodeHttp2ConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .tcp(VirtualNodeTcpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         .build())
                                 .build())
                         .healthCheck(HealthCheckProperty.builder()
                                 .healthyThreshold(123)
                                 .intervalMillis(123)
                                 .protocol("protocol")
                                 .timeoutMillis(123)
                                 .unhealthyThreshold(123)
                                 // the properties below are optional
                                 .path("path")
                                 .port(123)
                                 .build())
                         .outlierDetection(OutlierDetectionProperty.builder()
                                 .baseEjectionDuration(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .interval(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .maxEjectionPercent(123)
                                 .maxServerErrors(123)
                                 .build())
                         .timeout(ListenerTimeoutProperty.builder()
                                 .grpc(GrpcTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .http(HttpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .http2(HttpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .tcp(TcpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .build())
                         .tls(ListenerTlsProperty.builder()
                                 .certificate(ListenerTlsCertificateProperty.builder()
                                         .acm(ListenerTlsAcmCertificateProperty.builder()
                                                 .certificateArn("certificateArn")
                                                 .build())
                                         .file(ListenerTlsFileCertificateProperty.builder()
                                                 .certificateChain("certificateChain")
                                                 .privateKey("privateKey")
                                                 .build())
                                         .sds(ListenerTlsSdsCertificateProperty.builder()
                                                 .secretName("secretName")
                                                 .build())
                                         .build())
                                 .mode("mode")
                                 // the properties below are optional
                                 .validation(ListenerTlsValidationContextProperty.builder()
                                         .trust(ListenerTlsValidationContextTrustProperty.builder()
                                                 .file(TlsValidationContextFileTrustProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .build())
                                                 .sds(TlsValidationContextSdsTrustProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                         .exact(List.of("exact"))
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 .logging(LoggingProperty.builder()
                         .accessLog(AccessLogProperty.builder()
                                 .file(FileAccessLogProperty.builder()
                                         .path("path")
                                         // the properties below are optional
                                         .format(LoggingFormatProperty.builder()
                                                 .json(List.of(JsonFormatRefProperty.builder()
                                                         .key("key")
                                                         .value("value")
                                                         .build()))
                                                 .text("text")
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .serviceDiscovery(ServiceDiscoveryProperty.builder()
                         .awsCloudMap(AwsCloudMapServiceDiscoveryProperty.builder()
                                 .namespaceName("namespaceName")
                                 .serviceName("serviceName")
                                 // the properties below are optional
                                 .attributes(List.of(AwsCloudMapInstanceAttributeProperty.builder()
                                         .key("key")
                                         .value("value")
                                         .build()))
                                 .ipPreference("ipPreference")
                                 .build())
                         .dns(DnsServiceDiscoveryProperty.builder()
                                 .hostname("hostname")
                                 // the properties below are optional
                                 .ipPreference("ipPreference")
                                 .responseType("responseType")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualNodeName("virtualNodeName")
         .build();

  • Method Details

    • getMeshName

      @Stability(Stable) @NotNull String getMeshName()
      The name of the service mesh to create the virtual node in.

    • getSpec

      @Stability(Stable) @NotNull Object getSpec()
      The virtual node specification to apply.

    • 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 .

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Optional metadata that you can apply to the virtual node 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.

    • getVirtualNodeName

      @Stability(Stable) @Nullable default String getVirtualNodeName()
      The name to use for the virtual node.

    • builder

      @Stability(Stable) static CfnVirtualNodeProps.Builder builder()
      Returns:
      a CfnVirtualNodeProps.Builder of CfnVirtualNodeProps