CfnResponderGatewayPropsMixin

class aws_cdk.cfn_property_mixins.aws_rtbfabric.CfnResponderGatewayPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a responder gateway.

A domain name or managed endpoint is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_responder_gateway_props_mixin = rtbfabric.CfnResponderGatewayPropsMixin(rtbfabric.CfnResponderGatewayMixinProps(
    description="description",
    domain_name="domainName",
    managed_endpoint_configuration=rtbfabric.CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty(
        auto_scaling_groups_configuration=rtbfabric.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty(
            auto_scaling_group_name_list=["autoScalingGroupNameList"],
            health_check_config=rtbfabric.CfnResponderGatewayPropsMixin.HealthCheckConfigProperty(
                healthy_threshold_count=123,
                interval_seconds=123,
                path="path",
                port=123,
                protocol="protocol",
                status_code_matcher="statusCodeMatcher",
                timeout_ms=123,
                unhealthy_threshold_count=123
            ),
            role_arn="roleArn"
        ),
        eks_endpoints_configuration=rtbfabric.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=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    trust_store_configuration=rtbfabric.CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty(
        certificate_authority_certificates=["certificateAuthorityCertificates"]
    ),
    vpc_id="vpcId"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::RTBFabric::ResponderGateway.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

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)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

AutoScalingGroupsConfigurationProperty

class CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty(*, auto_scaling_group_name_list=None, health_check_config=None, role_arn=None)

Bases: object

Describes the configuration of an auto scaling group.

Parameters:

  • auto_scaling_group_name_list (Optional[Sequence[str]]) – The names of the auto scaling group.

  • health_check_config (Union[IResolvable, HealthCheckConfigProperty, Dict[str, Any], None])

  • role_arn (Optional[str]) – The role ARN of the auto scaling group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric

auto_scaling_groups_configuration_property = rtbfabric.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty(
    auto_scaling_group_name_list=["autoScalingGroupNameList"],
    health_check_config=rtbfabric.CfnResponderGatewayPropsMixin.HealthCheckConfigProperty(
        healthy_threshold_count=123,
        interval_seconds=123,
        path="path",
        port=123,
        protocol="protocol",
        status_code_matcher="statusCodeMatcher",
        timeout_ms=123,
        unhealthy_threshold_count=123
    ),
    role_arn="roleArn"
)

Attributes

auto_scaling_group_name_list

The names of the auto scaling group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-autoscalinggroupnamelist

health_check_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-healthcheckconfig

Type:

see

role_arn

The role ARN of the auto scaling group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-rolearn

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: object

Describes 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric

eks_endpoints_configuration_property = rtbfabric.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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clusterapiservercacertificatechain

cluster_api_server_endpoint_uri

The URI of the cluster API server endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clusterapiserverendpointuri

cluster_name

The name of the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clustername

endpoints_resource_name

The name of the endpoint resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcename

endpoints_resource_namespace

The namespace of the endpoint resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcenamespace

role_arn

The role ARN for the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-rolearn

HealthCheckConfigProperty

class CfnResponderGatewayPropsMixin.HealthCheckConfigProperty(*, healthy_threshold_count=None, interval_seconds=None, path=None, port=None, protocol=None, status_code_matcher=None, timeout_ms=None, unhealthy_threshold_count=None)

Bases: object

Parameters:

  • healthy_threshold_count (Union[int, float, None])

  • interval_seconds (Union[int, float, None])

  • path (Optional[str])

  • port (Union[int, float, None])

  • protocol (Optional[str])

  • status_code_matcher (Optional[str])

  • timeout_ms (Union[int, float, None])

  • unhealthy_threshold_count (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric

health_check_config_property = rtbfabric.CfnResponderGatewayPropsMixin.HealthCheckConfigProperty(
    healthy_threshold_count=123,
    interval_seconds=123,
    path="path",
    port=123,
    protocol="protocol",
    status_code_matcher="statusCodeMatcher",
    timeout_ms=123,
    unhealthy_threshold_count=123
)

Attributes

healthy_threshold_count

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-healthythresholdcount

Type:

see

interval_seconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-intervalseconds

Type:

see

path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-path

Type:

see

port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-port

Type:

see

protocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-protocol

Type:

see

status_code_matcher

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-statuscodematcher

Type:

see

timeout_ms

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-timeoutms

Type:

see

unhealthy_threshold_count

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-healthcheckconfig.html#cfn-rtbfabric-respondergateway-healthcheckconfig-unhealthythresholdcount

Type:

see

ManagedEndpointConfigurationProperty

class CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty(*, auto_scaling_groups_configuration=None, eks_endpoints_configuration=None)

Bases: object

Describes the configuration of a managed endpoint.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-managedendpointconfiguration.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric

managed_endpoint_configuration_property = rtbfabric.CfnResponderGatewayPropsMixin.ManagedEndpointConfigurationProperty(
    auto_scaling_groups_configuration=rtbfabric.CfnResponderGatewayPropsMixin.AutoScalingGroupsConfigurationProperty(
        auto_scaling_group_name_list=["autoScalingGroupNameList"],
        health_check_config=rtbfabric.CfnResponderGatewayPropsMixin.HealthCheckConfigProperty(
            healthy_threshold_count=123,
            interval_seconds=123,
            path="path",
            port=123,
            protocol="protocol",
            status_code_matcher="statusCodeMatcher",
            timeout_ms=123,
            unhealthy_threshold_count=123
        ),
        role_arn="roleArn"
    ),
    eks_endpoints_configuration=rtbfabric.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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-managedendpointconfiguration.html#cfn-rtbfabric-respondergateway-managedendpointconfiguration-autoscalinggroupsconfiguration

eks_endpoints_configuration

Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-managedendpointconfiguration.html#cfn-rtbfabric-respondergateway-managedendpointconfiguration-eksendpointsconfiguration

TrustStoreConfigurationProperty

class CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty(*, certificate_authority_certificates=None)

Bases: object

Describes the configuration of a trust store.

Parameters:

certificate_authority_certificates (Optional[Sequence[str]]) – The certificate authority certificate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html

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.cfn_property_mixins import aws_rtbfabric as rtbfabric

trust_store_configuration_property = rtbfabric.CfnResponderGatewayPropsMixin.TrustStoreConfigurationProperty(
    certificate_authority_certificates=["certificateAuthorityCertificates"]
)

Attributes

certificate_authority_certificates

The certificate authority certificate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html#cfn-rtbfabric-respondergateway-truststoreconfiguration-certificateauthoritycertificates