CfnVirtualGatewayProps
- class aws_cdk.aws_appmesh.CfnVirtualGatewayProps(*, mesh_name, spec, mesh_owner=None, tags=None, virtual_gateway_name=None)
Bases:
object
Properties for defining a
CfnVirtualGateway
.- Parameters:
mesh_name (
str
) – The name of the service mesh that the virtual gateway resides in.spec (
Union
[IResolvable
,VirtualGatewaySpecProperty
,Dict
[str
,Any
]]) – The specifications of the virtual gateway.mesh_owner (
Optional
[str
]) – 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 .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Optional metadata that you can apply to the virtual gateway 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_gateway_name (
Optional
[str
]) – The name of the virtual gateway.
- 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_gateway_props = appmesh.CfnVirtualGatewayProps( mesh_name="meshName", spec=appmesh.CfnVirtualGateway.VirtualGatewaySpecProperty( listeners=[appmesh.CfnVirtualGateway.VirtualGatewayListenerProperty( port_mapping=appmesh.CfnVirtualGateway.VirtualGatewayPortMappingProperty( port=123, protocol="protocol" ), # the properties below are optional connection_pool=appmesh.CfnVirtualGateway.VirtualGatewayConnectionPoolProperty( grpc=appmesh.CfnVirtualGateway.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 ), http=appmesh.CfnVirtualGateway.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, # the properties below are optional max_pending_requests=123 ), http2=appmesh.CfnVirtualGateway.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 ) ), health_check=appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty( healthy_threshold=123, interval_millis=123, protocol="protocol", timeout_millis=123, unhealthy_threshold=123, # the properties below are optional path="path", port=123 ), tls=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsProperty( certificate=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), mode="mode", # the properties below are optional validation=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextProperty( trust=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ), # the properties below are optional subject_alternative_names=appmesh.CfnVirtualGateway.SubjectAlternativeNamesProperty( match=appmesh.CfnVirtualGateway.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ) ) ) )], # the properties below are optional backend_defaults=appmesh.CfnVirtualGateway.VirtualGatewayBackendDefaultsProperty( client_policy=appmesh.CfnVirtualGateway.VirtualGatewayClientPolicyProperty( tls=appmesh.CfnVirtualGateway.VirtualGatewayClientPolicyTlsProperty( validation=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextProperty( trust=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh.CfnVirtualGateway.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ), # the properties below are optional subject_alternative_names=appmesh.CfnVirtualGateway.SubjectAlternativeNamesProperty( match=appmesh.CfnVirtualGateway.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ) ), # the properties below are optional certificate=appmesh.CfnVirtualGateway.VirtualGatewayClientTlsCertificateProperty( file=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh.CfnVirtualGateway.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123] ) ) ), logging=appmesh.CfnVirtualGateway.VirtualGatewayLoggingProperty( access_log=appmesh.CfnVirtualGateway.VirtualGatewayAccessLogProperty( file=appmesh.CfnVirtualGateway.VirtualGatewayFileAccessLogProperty( path="path", # the properties below are optional format=appmesh.CfnVirtualGateway.LoggingFormatProperty( json=[appmesh.CfnVirtualGateway.JsonFormatRefProperty( key="key", value="value" )], text="text" ) ) ) ) ), # the properties below are optional mesh_owner="meshOwner", tags=[CfnTag( key="key", value="value" )], virtual_gateway_name="virtualGatewayName" )
Attributes
- mesh_name
The name of the service mesh that the virtual gateway resides in.
- 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 .
- spec
The specifications of the virtual gateway.
- tags
Optional metadata that you can apply to the virtual gateway 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_gateway_name
The name of the virtual gateway.