CfnHostPropsMixin

class aws_cdk.cfn_property_mixins.aws_codeconnections.CfnHostPropsMixin(props, *, strategy=None)

Bases: Mixin

A resource that represents the infrastructure where a third-party provider is installed.

You create one host for all connections to that provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-host.html

CloudformationResource:

AWS::CodeConnections::Host

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_codeconnections as codeconnections
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_host_props_mixin = codeconnections.CfnHostPropsMixin(codeconnections.CfnHostMixinProps(
    name="name",
    provider_endpoint="providerEndpoint",
    provider_type="providerType",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    vpc_configuration=codeconnections.CfnHostPropsMixin.VpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"],
        tls_certificate="tlsCertificate",
        vpc_id="vpcId"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::CodeConnections::Host.

Parameters:
  • props (Union[CfnHostMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

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 = ['name', 'providerEndpoint', 'providerType', 'tags', 'vpcConfiguration']

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.

VpcConfigurationProperty

class CfnHostPropsMixin.VpcConfigurationProperty(*, security_group_ids=None, subnet_ids=None, tls_certificate=None, vpc_id=None)

Bases: object

The VPC configuration provisioned for the host.

Parameters:
  • security_group_ids (Optional[Sequence[str]]) – The ID of the security group or security groups associated with the Amazon VPC.

  • subnet_ids (Optional[Sequence[str]]) – The ID of the subnet or subnets associated with the Amazon VPC.

  • tls_certificate (Optional[str]) – The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

  • vpc_id (Optional[str]) – The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-host-vpcconfiguration.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_codeconnections as codeconnections

vpc_configuration_property = codeconnections.CfnHostPropsMixin.VpcConfigurationProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"],
    tls_certificate="tlsCertificate",
    vpc_id="vpcId"
)

Attributes

security_group_ids

The ID of the security group or security groups associated with the Amazon VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-host-vpcconfiguration.html#cfn-codeconnections-host-vpcconfiguration-securitygroupids

subnet_ids

The ID of the subnet or subnets associated with the Amazon VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-host-vpcconfiguration.html#cfn-codeconnections-host-vpcconfiguration-subnetids

tls_certificate

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-host-vpcconfiguration.html#cfn-codeconnections-host-vpcconfiguration-tlscertificate

vpc_id

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-host-vpcconfiguration.html#cfn-codeconnections-host-vpcconfiguration-vpcid