CfnVirtualGatewayPropsMixin
- class aws_cdk.mixins_preview.aws_appmesh.mixins.CfnVirtualGatewayPropsMixin(props, *, strategy=None)
Bases:
MixinCreates a virtual gateway.
A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
For more information about virtual gateways, see Virtual gateways .
- See:
- CloudformationResource:
AWS::AppMesh::VirtualGateway
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins cfn_virtual_gateway_props_mixin = appmesh_mixins.CfnVirtualGatewayPropsMixin(appmesh_mixins.CfnVirtualGatewayMixinProps( mesh_name="meshName", mesh_owner="meshOwner", spec=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewaySpecProperty( backend_defaults=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayBackendDefaultsProperty( client_policy=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty( tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123], validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) ) ), listeners=[appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerProperty( connection_pool=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty( grpc=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 ), http=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, max_pending_requests=123 ), http2=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 ) ), health_check=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty( healthy_threshold=123, interval_millis=123, path="path", port=123, protocol="protocol", timeout_millis=123, unhealthy_threshold=123 ), port_mapping=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty( port=123, protocol="protocol" ), tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), mode="mode", validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) )], logging=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayLoggingProperty( access_log=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty( format=appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" ), path="path" ) ) ) ), tags=[CfnTag( key="key", value="value" )], virtual_gateway_name="virtualGatewayName" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::AppMesh::VirtualGateway.- Parameters:
props (
Union[CfnVirtualGatewayMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['meshName', 'meshOwner', 'spec', 'tags', 'virtualGatewayName']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
JsonFormatRefProperty
- class CfnVirtualGatewayPropsMixin.JsonFormatRefProperty(*, key=None, value=None)
Bases:
objectAn object that represents the key value pairs for the JSON.
- Parameters:
key (
Optional[str]) – The specified key for the JSON.value (
Optional[str]) – The specified value for the JSON.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins json_format_ref_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )
Attributes
- key
The specified key for the JSON.
- value
The specified value for the JSON.
LoggingFormatProperty
- class CfnVirtualGatewayPropsMixin.LoggingFormatProperty(*, json=None, text=None)
Bases:
objectAn object that represents the format for the logs.
- Parameters:
json (
Union[IResolvable,Sequence[Union[IResolvable,JsonFormatRefProperty,Dict[str,Any]]],None]) – The logging format for JSON.text (
Optional[str]) – The logging format for text.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins logging_format_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" )
Attributes
- json
The logging format for JSON.
SubjectAlternativeNameMatchersProperty
- class CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty(*, exact=None)
Bases:
objectAn object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
- Parameters:
exact (
Optional[Sequence[str]]) – The values sent must match the specified values exactly.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins subject_alternative_name_matchers_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] )
Attributes
- exact
The values sent must match the specified values exactly.
SubjectAlternativeNamesProperty
- class CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty(*, match=None)
Bases:
objectAn object that represents the subject alternative names secured by the certificate.
- Parameters:
match (
Union[IResolvable,SubjectAlternativeNameMatchersProperty,Dict[str,Any],None]) – An object that represents the criteria for determining a SANs match.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins subject_alternative_names_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) )
Attributes
- match
An object that represents the criteria for determining a SANs match.
VirtualGatewayAccessLogProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty(*, file=None)
Bases:
objectThe access log configuration for a virtual gateway.
- Parameters:
file (
Union[IResolvable,VirtualGatewayFileAccessLogProperty,Dict[str,Any],None]) – The file object to send virtual gateway access logs to.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_access_log_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty( format=appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" ), path="path" ) )
Attributes
- file
The file object to send virtual gateway access logs to.
VirtualGatewayBackendDefaultsProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayBackendDefaultsProperty(*, client_policy=None)
Bases:
objectAn object that represents the default properties for a backend.
- Parameters:
client_policy (
Union[IResolvable,VirtualGatewayClientPolicyProperty,Dict[str,Any],None]) – A reference to an object that represents a client policy.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_backend_defaults_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayBackendDefaultsProperty( client_policy=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty( tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123], validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) ) )
Attributes
- client_policy
A reference to an object that represents a client policy.
VirtualGatewayClientPolicyProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty(*, tls=None)
Bases:
objectAn object that represents a client policy.
- Parameters:
tls (
Union[IResolvable,VirtualGatewayClientPolicyTlsProperty,Dict[str,Any],None]) – A reference to an object that represents a Transport Layer Security (TLS) client policy.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_client_policy_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty( tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123], validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) )
Attributes
- tls
A reference to an object that represents a Transport Layer Security (TLS) client policy.
VirtualGatewayClientPolicyTlsProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty(*, certificate=None, enforce=None, ports=None, validation=None)
Bases:
objectAn object that represents a Transport Layer Security (TLS) client policy.
- Parameters:
certificate (
Union[IResolvable,VirtualGatewayClientTlsCertificateProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s client’s Transport Layer Security (TLS) certificate.enforce (
Union[bool,IResolvable,None]) – Whether the policy is enforced. The default isTrue, if a value isn’t specified.ports (
Union[Sequence[Union[int,float]],IResolvable,None]) – One or more ports that the policy is enforced for.validation (
Union[IResolvable,VirtualGatewayTlsValidationContextProperty,Dict[str,Any],None]) – A reference to an object that represents a Transport Layer Security (TLS) validation context.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_client_policy_tls_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123], validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) )
Attributes
- certificate
A reference to an object that represents a virtual gateway’s client’s Transport Layer Security (TLS) certificate.
- enforce
Whether the policy is enforced.
The default is
True, if a value isn’t specified.
- ports
One or more ports that the policy is enforced for.
- validation
A reference to an object that represents a Transport Layer Security (TLS) validation context.
VirtualGatewayClientTlsCertificateProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty(*, file=None, sds=None)
Bases:
objectAn object that represents the virtual gateway’s client’s Transport Layer Security (TLS) certificate.
- Parameters:
file (
Union[IResolvable,VirtualGatewayListenerTlsFileCertificateProperty,Dict[str,Any],None]) – An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .sds (
Union[IResolvable,VirtualGatewayListenerTlsSdsCertificateProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s client’s Secret Discovery Service certificate.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_client_tls_certificate_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) )
Attributes
- file
An object that represents a local file certificate.
The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
- sds
A reference to an object that represents a virtual gateway’s client’s Secret Discovery Service certificate.
VirtualGatewayConnectionPoolProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty(*, grpc=None, http=None, http2=None)
Bases:
objectAn object that represents the type of virtual gateway connection pool.
Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.
If not present the default value for
maxPendingRequestsis2147483647.- Parameters:
grpc (
Union[IResolvable,VirtualGatewayGrpcConnectionPoolProperty,Dict[str,Any],None]) – An object that represents a type of connection pool.http (
Union[IResolvable,VirtualGatewayHttpConnectionPoolProperty,Dict[str,Any],None]) – An object that represents a type of connection pool.http2 (
Union[IResolvable,VirtualGatewayHttp2ConnectionPoolProperty,Dict[str,Any],None]) – An object that represents a type of connection pool.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_connection_pool_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty( grpc=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 ), http=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, max_pending_requests=123 ), http2=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 ) )
Attributes
- grpc
An object that represents a type of connection pool.
- http
An object that represents a type of connection pool.
- http2
An object that represents a type of connection pool.
VirtualGatewayFileAccessLogProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty(*, format=None, path=None)
Bases:
objectAn object that represents an access log file.
- Parameters:
format (
Union[IResolvable,LoggingFormatProperty,Dict[str,Any],None]) – The specified format for the virtual gateway access logs. It can be eitherjson_formatortext_format.path (
Optional[str]) – The file path to write access logs to. You can use/dev/stdoutto send access logs to standard out and configure your Envoy container to use a log driver, such asawslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container’s file system to write the files to disk.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_file_access_log_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty( format=appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" ), path="path" )
Attributes
- format
The specified format for the virtual gateway access logs.
It can be either
json_formatortext_format.
- path
The file path to write access logs to.
You can use
/dev/stdoutto send access logs to standard out and configure your Envoy container to use a log driver, such asawslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container’s file system to write the files to disk.
VirtualGatewayGrpcConnectionPoolProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty(*, max_requests=None)
Bases:
objectAn object that represents a type of connection pool.
- Parameters:
max_requests (
Union[int,float,None]) – Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_grpc_connection_pool_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 )
Attributes
- max_requests
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
VirtualGatewayHealthCheckPolicyProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty(*, healthy_threshold=None, interval_millis=None, path=None, port=None, protocol=None, timeout_millis=None, unhealthy_threshold=None)
Bases:
objectAn object that represents the health check policy for a virtual gateway’s listener.
- Parameters:
healthy_threshold (
Union[int,float,None]) – The number of consecutive successful health checks that must occur before declaring the listener healthy.interval_millis (
Union[int,float,None]) – The time period in milliseconds between each health check execution.path (
Optional[str]) – The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.port (
Union[int,float,None]) – The destination port for the health check request. This port must match the port defined in thePortMappingfor the listener.protocol (
Optional[str]) – The protocol for the health check request. If you specifygrpc, then your service must conform to the GRPC Health Checking Protocol .timeout_millis (
Union[int,float,None]) – The amount of time to wait when receiving a response from the health check, in milliseconds.unhealthy_threshold (
Union[int,float,None]) – The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_health_check_policy_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty( healthy_threshold=123, interval_millis=123, path="path", port=123, protocol="protocol", timeout_millis=123, unhealthy_threshold=123 )
Attributes
- healthy_threshold
The number of consecutive successful health checks that must occur before declaring the listener healthy.
- interval_millis
The time period in milliseconds between each health check execution.
- path
The destination path for the health check request.
This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
- port
The destination port for the health check request.
This port must match the port defined in the
PortMappingfor the listener.
- protocol
The protocol for the health check request.
If you specify
grpc, then your service must conform to the GRPC Health Checking Protocol .
- timeout_millis
The amount of time to wait when receiving a response from the health check, in milliseconds.
- unhealthy_threshold
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
VirtualGatewayHttp2ConnectionPoolProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty(*, max_requests=None)
Bases:
objectAn object that represents a type of connection pool.
- Parameters:
max_requests (
Union[int,float,None]) – Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_http2_connection_pool_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 )
Attributes
- max_requests
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
VirtualGatewayHttpConnectionPoolProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty(*, max_connections=None, max_pending_requests=None)
Bases:
objectAn object that represents a type of connection pool.
- Parameters:
max_connections (
Union[int,float,None]) – Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.max_pending_requests (
Union[int,float,None]) – Number of overflowing requests aftermax_connectionsEnvoy will queue to upstream cluster.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_http_connection_pool_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, max_pending_requests=123 )
Attributes
- max_connections
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
- max_pending_requests
Number of overflowing requests after
max_connectionsEnvoy will queue to upstream cluster.
VirtualGatewayListenerProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerProperty(*, connection_pool=None, health_check=None, port_mapping=None, tls=None)
Bases:
objectAn object that represents a listener for a virtual gateway.
- Parameters:
connection_pool (
Union[IResolvable,VirtualGatewayConnectionPoolProperty,Dict[str,Any],None]) – The connection pool information for the listener.health_check (
Union[IResolvable,VirtualGatewayHealthCheckPolicyProperty,Dict[str,Any],None]) – The health check information for the listener.port_mapping (
Union[IResolvable,VirtualGatewayPortMappingProperty,Dict[str,Any],None]) – The port mapping information for the listener.tls (
Union[IResolvable,VirtualGatewayListenerTlsProperty,Dict[str,Any],None]) – A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerProperty( connection_pool=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty( grpc=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 ), http=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, max_pending_requests=123 ), http2=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 ) ), health_check=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty( healthy_threshold=123, interval_millis=123, path="path", port=123, protocol="protocol", timeout_millis=123, unhealthy_threshold=123 ), port_mapping=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty( port=123, protocol="protocol" ), tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), mode="mode", validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) )
Attributes
- connection_pool
The connection pool information for the listener.
- health_check
The health check information for the listener.
- port_mapping
The port mapping information for the listener.
- tls
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
VirtualGatewayListenerTlsAcmCertificateProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty(*, certificate_arn=None)
Bases:
objectAn object that represents an Certificate Manager certificate.
- Parameters:
certificate_arn (
Optional[str]) –The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_acm_certificate_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" )
Attributes
- certificate_arn
The Amazon Resource Name (ARN) for the certificate.
The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
VirtualGatewayListenerTlsCertificateProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty(*, acm=None, file=None, sds=None)
Bases:
objectAn object that represents a listener’s Transport Layer Security (TLS) certificate.
- Parameters:
acm (
Union[IResolvable,VirtualGatewayListenerTlsAcmCertificateProperty,Dict[str,Any],None]) – A reference to an object that represents an Certificate Manager certificate.file (
Union[IResolvable,VirtualGatewayListenerTlsFileCertificateProperty,Dict[str,Any],None]) – A reference to an object that represents a local file certificate.sds (
Union[IResolvable,VirtualGatewayListenerTlsSdsCertificateProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s listener’s Secret Discovery Service certificate.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_certificate_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) )
Attributes
- acm
A reference to an object that represents an Certificate Manager certificate.
- file
A reference to an object that represents a local file certificate.
- sds
A reference to an object that represents a virtual gateway’s listener’s Secret Discovery Service certificate.
VirtualGatewayListenerTlsFileCertificateProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty(*, certificate_chain=None, private_key=None)
Bases:
objectAn object that represents a local file certificate.
The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
- Parameters:
certificate_chain (
Optional[str]) – The certificate chain for the certificate.private_key (
Optional[str]) – The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_file_certificate_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" )
Attributes
- certificate_chain
The certificate chain for the certificate.
- private_key
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
VirtualGatewayListenerTlsProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty(*, certificate=None, mode=None, validation=None)
Bases:
objectAn object that represents the Transport Layer Security (TLS) properties for a listener.
- Parameters:
certificate (
Union[IResolvable,VirtualGatewayListenerTlsCertificateProperty,Dict[str,Any],None]) – An object that represents a Transport Layer Security (TLS) certificate.mode (
Optional[str]) – Specify one of the following modes. - ** STRICT – Listener only accepts connections with TLS enabled. - ** PERMISSIVE – Listener accepts connections with or without TLS enabled. - ** DISABLED – Listener only accepts connections without TLS.validation (
Union[IResolvable,VirtualGatewayListenerTlsValidationContextProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) validation context.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), mode="mode", validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) )
Attributes
- certificate
An object that represents a Transport Layer Security (TLS) certificate.
- mode
Specify one of the following modes.
** STRICT – Listener only accepts connections with TLS enabled.
** PERMISSIVE – Listener accepts connections with or without TLS enabled.
** DISABLED – Listener only accepts connections without TLS.
- validation
A reference to an object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) validation context.
VirtualGatewayListenerTlsSdsCertificateProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty(*, secret_name=None)
Bases:
objectAn object that represents the virtual gateway’s listener’s Secret Discovery Service certificate.The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
- Parameters:
secret_name (
Optional[str]) – A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_sds_certificate_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" )
Attributes
- secret_name
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
VirtualGatewayListenerTlsValidationContextProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty(*, subject_alternative_names=None, trust=None)
Bases:
objectAn object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) validation context.
- Parameters:
subject_alternative_names (
Union[IResolvable,SubjectAlternativeNamesProperty,Dict[str,Any],None]) – A reference to an object that represents the SANs for a virtual gateway listener’s Transport Layer Security (TLS) validation context.trust (
Union[IResolvable,VirtualGatewayListenerTlsValidationContextTrustProperty,Dict[str,Any],None]) – A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_validation_context_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) )
Attributes
- subject_alternative_names
A reference to an object that represents the SANs for a virtual gateway listener’s Transport Layer Security (TLS) validation context.
- trust
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
VirtualGatewayListenerTlsValidationContextTrustProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty(*, file=None, sds=None)
Bases:
objectAn object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) validation context trust.
- Parameters:
file (
Union[IResolvable,VirtualGatewayTlsValidationContextFileTrustProperty,Dict[str,Any],None]) – An object that represents a Transport Layer Security (TLS) validation context trust for a local file.sds (
Union[IResolvable,VirtualGatewayTlsValidationContextSdsTrustProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_listener_tls_validation_context_trust_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) )
Attributes
- file
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
- sds
A reference to an object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.
VirtualGatewayLoggingProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayLoggingProperty(*, access_log=None)
Bases:
objectAn object that represents logging information.
- Parameters:
access_log (
Union[IResolvable,VirtualGatewayAccessLogProperty,Dict[str,Any],None]) – The access log configuration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_logging_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayLoggingProperty( access_log=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty( format=appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" ), path="path" ) ) )
Attributes
VirtualGatewayPortMappingProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty(*, port=None, protocol=None)
Bases:
objectAn object that represents a port mapping.
- Parameters:
port (
Union[int,float,None]) – The port used for the port mapping. Specify one protocol.protocol (
Optional[str]) – The protocol used for the port mapping.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_port_mapping_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty( port=123, protocol="protocol" )
Attributes
- port
The port used for the port mapping.
Specify one protocol.
- protocol
The protocol used for the port mapping.
VirtualGatewaySpecProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewaySpecProperty(*, backend_defaults=None, listeners=None, logging=None)
Bases:
objectAn object that represents the specification of a service mesh resource.
- Parameters:
backend_defaults (
Union[IResolvable,VirtualGatewayBackendDefaultsProperty,Dict[str,Any],None]) – A reference to an object that represents the defaults for backends.listeners (
Union[IResolvable,Sequence[Union[IResolvable,VirtualGatewayListenerProperty,Dict[str,Any]]],None]) – The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.logging (
Union[IResolvable,VirtualGatewayLoggingProperty,Dict[str,Any],None]) – An object that represents logging information.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_spec_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewaySpecProperty( backend_defaults=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayBackendDefaultsProperty( client_policy=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty( tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), enforce=False, ports=[123], validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) ) ), listeners=[appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerProperty( connection_pool=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty( grpc=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty( max_requests=123 ), http=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty( max_connections=123, max_pending_requests=123 ), http2=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty( max_requests=123 ) ), health_check=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty( healthy_threshold=123, interval_millis=123, path="path", port=123, protocol="protocol", timeout_millis=123, unhealthy_threshold=123 ), port_mapping=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty( port=123, protocol="protocol" ), tls=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty( certificate=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty( certificate_arn="certificateArn" ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty( certificate_chain="certificateChain", private_key="privateKey" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty( secret_name="secretName" ) ), mode="mode", validation=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) ) ) )], logging=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayLoggingProperty( access_log=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty( file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty( format=appmesh_mixins.CfnVirtualGatewayPropsMixin.LoggingFormatProperty( json=[appmesh_mixins.CfnVirtualGatewayPropsMixin.JsonFormatRefProperty( key="key", value="value" )], text="text" ), path="path" ) ) ) )
Attributes
- backend_defaults
A reference to an object that represents the defaults for backends.
- listeners
The listeners that the mesh endpoint is expected to receive inbound traffic from.
You can specify one listener.
- logging
An object that represents logging information.
VirtualGatewayTlsValidationContextAcmTrustProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty(*, certificate_authority_arns=None)
Bases:
objectAn object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
- Parameters:
certificate_authority_arns (
Optional[Sequence[str]]) – One or more ACM Amazon Resource Name (ARN)s.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_tls_validation_context_acm_trust_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] )
Attributes
- certificate_authority_arns
One or more ACM Amazon Resource Name (ARN)s.
VirtualGatewayTlsValidationContextFileTrustProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty(*, certificate_chain=None)
Bases:
objectAn object that represents a Transport Layer Security (TLS) validation context trust for a local file.
- Parameters:
certificate_chain (
Optional[str]) – The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_tls_validation_context_file_trust_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" )
Attributes
- certificate_chain
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
VirtualGatewayTlsValidationContextProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty(*, subject_alternative_names=None, trust=None)
Bases:
objectAn object that represents a Transport Layer Security (TLS) validation context.
- Parameters:
subject_alternative_names (
Union[IResolvable,SubjectAlternativeNamesProperty,Dict[str,Any],None]) – A reference to an object that represents the SANs for a virtual gateway’s listener’s Transport Layer Security (TLS) validation context.trust (
Union[IResolvable,VirtualGatewayTlsValidationContextTrustProperty,Dict[str,Any],None]) – A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_tls_validation_context_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty( subject_alternative_names=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty( match=appmesh_mixins.CfnVirtualGatewayPropsMixin.SubjectAlternativeNameMatchersProperty( exact=["exact"] ) ), trust=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) ) )
Attributes
- subject_alternative_names
A reference to an object that represents the SANs for a virtual gateway’s listener’s Transport Layer Security (TLS) validation context.
- trust
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
VirtualGatewayTlsValidationContextSdsTrustProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty(*, secret_name=None)
Bases:
objectAn object that represents a virtual gateway’s listener’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
- Parameters:
secret_name (
Optional[str]) – A reference to an object that represents the name of the secret for a virtual gateway’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_tls_validation_context_sds_trust_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" )
Attributes
- secret_name
A reference to an object that represents the name of the secret for a virtual gateway’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.
VirtualGatewayTlsValidationContextTrustProperty
- class CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty(*, acm=None, file=None, sds=None)
Bases:
objectAn object that represents a Transport Layer Security (TLS) validation context trust.
- Parameters:
acm (
Union[IResolvable,VirtualGatewayTlsValidationContextAcmTrustProperty,Dict[str,Any],None]) – A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.file (
Union[IResolvable,VirtualGatewayTlsValidationContextFileTrustProperty,Dict[str,Any],None]) – An object that represents a Transport Layer Security (TLS) validation context trust for a local file.sds (
Union[IResolvable,VirtualGatewayTlsValidationContextSdsTrustProperty,Dict[str,Any],None]) – A reference to an object that represents a virtual gateway’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins virtual_gateway_tls_validation_context_trust_property = appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty( acm=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty( certificate_authority_arns=["certificateAuthorityArns"] ), file=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty( certificate_chain="certificateChain" ), sds=appmesh_mixins.CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty( secret_name="secretName" ) )
Attributes
- acm
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
- file
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
- sds
A reference to an object that represents a virtual gateway’s Transport Layer Security (TLS) Secret Discovery Service validation context trust.