CfnResponderGatewayPropsMixin
- class aws_cdk.mixins_preview.aws_rtbfabric.mixins.CfnResponderGatewayPropsMixin(props, *, strategy=None)
Bases:
MixinCreates a responder gateway.
A domain name or managed endpoint is required.
- See:
- CloudformationResource:
AWS::RTBFabric::ResponderGateway
- 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_rtbfabric import mixins as rtbfabric_mixins cfn_responder_gateway_props_mixin = rtbfabric_mixins.CfnResponderGatewayPropsMixin(rtbfabric_mixins.CfnResponderGatewayMixinProps( description="description", domain_name="domainName", managed_endpoint_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty( auto_scaling_groups_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty( auto_scaling_group_name_list=["autoScalingGroupNameList"], role_arn="roleArn" ), eks_endpoints_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.EksEndpointsConfigurationProperty( cluster_api_server_ca_certificate_chain="clusterApiServerCaCertificateChain", cluster_api_server_endpoint_uri="clusterApiServerEndpointUri", cluster_name="clusterName", endpoints_resource_name="endpointsResourceName", endpoints_resource_namespace="endpointsResourceNamespace", role_arn="roleArn" ) ), port=123, protocol="protocol", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], tags=[CfnTag( key="key", value="value" )], trust_store_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty( certificate_authority_certificates=["certificateAuthorityCertificates"] ), vpc_id="vpcId" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::RTBFabric::ResponderGateway.- Parameters:
props (
Union[CfnResponderGatewayMixinProps,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 = ['description', 'domainName', 'managedEndpointConfiguration', 'port', 'protocol', 'securityGroupIds', 'subnetIds', 'tags', 'trustStoreConfiguration', 'vpcId']
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
AutoScalingGroupsConfigurationProperty
- class CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty(*, auto_scaling_group_name_list=None, role_arn=None)
Bases:
objectDescribes the configuration of an auto scaling group.
- Parameters:
auto_scaling_group_name_list (
Optional[Sequence[str]]) – The names of the auto scaling group.role_arn (
Optional[str]) – The role ARN of the auto scaling group.
- 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_rtbfabric import mixins as rtbfabric_mixins auto_scaling_groups_configuration_property = rtbfabric_mixins.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty( auto_scaling_group_name_list=["autoScalingGroupNameList"], role_arn="roleArn" )
Attributes
- auto_scaling_group_name_list
The names of the auto scaling group.
- role_arn
The role ARN of the auto scaling group.
EksEndpointsConfigurationProperty
- class CfnResponderGatewayPropsMixin.EksEndpointsConfigurationProperty(*, cluster_api_server_ca_certificate_chain=None, cluster_api_server_endpoint_uri=None, cluster_name=None, endpoints_resource_name=None, endpoints_resource_namespace=None, role_arn=None)
Bases:
objectDescribes the configuration of an Amazon Elastic Kubernetes Service endpoint.
- Parameters:
cluster_api_server_ca_certificate_chain (
Optional[str]) – The CA certificate chain of the cluster API server.cluster_api_server_endpoint_uri (
Optional[str]) – The URI of the cluster API server endpoint.cluster_name (
Optional[str]) – The name of the cluster.endpoints_resource_name (
Optional[str]) – The name of the endpoint resource.endpoints_resource_namespace (
Optional[str]) – The namespace of the endpoint resource.role_arn (
Optional[str]) – The role ARN for the 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_rtbfabric import mixins as rtbfabric_mixins eks_endpoints_configuration_property = rtbfabric_mixins.CfnResponderGatewayPropsMixin.EksEndpointsConfigurationProperty( cluster_api_server_ca_certificate_chain="clusterApiServerCaCertificateChain", cluster_api_server_endpoint_uri="clusterApiServerEndpointUri", cluster_name="clusterName", endpoints_resource_name="endpointsResourceName", endpoints_resource_namespace="endpointsResourceNamespace", role_arn="roleArn" )
Attributes
- cluster_api_server_ca_certificate_chain
The CA certificate chain of the cluster API server.
- cluster_api_server_endpoint_uri
The URI of the cluster API server endpoint.
- cluster_name
The name of the cluster.
- endpoints_resource_name
The name of the endpoint resource.
- endpoints_resource_namespace
The namespace of the endpoint resource.
ManagedEndpointConfigurationProperty
- class CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty(*, auto_scaling_groups_configuration=None, eks_endpoints_configuration=None)
Bases:
objectDescribes the configuration of a managed endpoint.
- Parameters:
auto_scaling_groups_configuration (
Union[IResolvable,AutoScalingGroupsConfigurationProperty,Dict[str,Any],None]) – Describes the configuration of an auto scaling group.eks_endpoints_configuration (
Union[IResolvable,EksEndpointsConfigurationProperty,Dict[str,Any],None]) – Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
- 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_rtbfabric import mixins as rtbfabric_mixins managed_endpoint_configuration_property = rtbfabric_mixins.CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty( auto_scaling_groups_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty( auto_scaling_group_name_list=["autoScalingGroupNameList"], role_arn="roleArn" ), eks_endpoints_configuration=rtbfabric_mixins.CfnResponderGatewayPropsMixin.EksEndpointsConfigurationProperty( cluster_api_server_ca_certificate_chain="clusterApiServerCaCertificateChain", cluster_api_server_endpoint_uri="clusterApiServerEndpointUri", cluster_name="clusterName", endpoints_resource_name="endpointsResourceName", endpoints_resource_namespace="endpointsResourceNamespace", role_arn="roleArn" ) )
Attributes
- auto_scaling_groups_configuration
Describes the configuration of an auto scaling group.
- eks_endpoints_configuration
Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
TrustStoreConfigurationProperty
- class CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty(*, certificate_authority_certificates=None)
Bases:
objectDescribes the configuration of a trust store.
- Parameters:
certificate_authority_certificates (
Optional[Sequence[str]]) – The certificate authority 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_rtbfabric import mixins as rtbfabric_mixins trust_store_configuration_property = rtbfabric_mixins.CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty( certificate_authority_certificates=["certificateAuthorityCertificates"] )
Attributes
- certificate_authority_certificates
The certificate authority certificate.