Skip to content
v2.276.0

CfnPrivateConnectionProps Struct Added in v2.276.0 ​

Properties for defining a CfnPrivateConnection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityagent as securityagent } from 'aws-cdk-lib';
const cfnPrivateConnectionProps: securityagent.CfnPrivateConnectionProps = {
  privateConnectionName: 'privateConnectionName',

  // the properties below are optional
  certificate: 'certificate',
  mode: {
    selfManaged: {
      resourceConfigurationId: 'resourceConfigurationId',
    },
    serviceManaged: {
      hostAddress: 'hostAddress',
      subnetIds: ['subnetIds'],
      vpcId: 'vpcId',

      // the properties below are optional
      dnsResolution: 'dnsResolution',
      ipAddressType: 'ipAddressType',
      ipv4AddressesPerEni: 123,
      portRanges: ['portRanges'],
      securityGroupIds: ['securityGroupIds'],
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securityagent as securityagent

cfn_private_connection_props = securityagent.CfnPrivateConnectionProps(
    private_connection_name="privateConnectionName",

    # the properties below are optional
    certificate="certificate",
    mode=securityagent.CfnPrivateConnection.ModeProperty(
        self_managed=securityagent.CfnPrivateConnection.SelfManagedProperty(
            resource_configuration_id="resourceConfigurationId"
        ),
        service_managed=securityagent.CfnPrivateConnection.ServiceManagedProperty(
            host_address="hostAddress",
            subnet_ids=["subnetIds"],
            vpc_id="vpcId",

            # the properties below are optional
            dns_resolution="dnsResolution",
            ip_address_type="ipAddressType",
            ipv4_addresses_per_eni=123,
            port_ranges=["portRanges"],
            security_group_ids=["securityGroupIds"]
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityagent.*;

CfnPrivateConnectionProps cfnPrivateConnectionProps = CfnPrivateConnectionProps.builder()
        .privateConnectionName("privateConnectionName")

        // the properties below are optional
        .certificate("certificate")
        .mode(ModeProperty.builder()
                .selfManaged(SelfManagedProperty.builder()
                        .resourceConfigurationId("resourceConfigurationId")
                        .build())
                .serviceManaged(ServiceManagedProperty.builder()
                        .hostAddress("hostAddress")
                        .subnetIds(List.of("subnetIds"))
                        .vpcId("vpcId")

                        // the properties below are optional
                        .dnsResolution("dnsResolution")
                        .ipAddressType("ipAddressType")
                        .ipv4AddressesPerEni(123)
                        .portRanges(List.of("portRanges"))
                        .securityGroupIds(List.of("securityGroupIds"))
                        .build())
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityAgent;

var cfnPrivateConnectionProps = new CfnPrivateConnectionProps {
    PrivateConnectionName = "privateConnectionName",

    // the properties below are optional
    Certificate = "certificate",
    Mode = new ModeProperty {
        SelfManaged = new SelfManagedProperty {
            ResourceConfigurationId = "resourceConfigurationId"
        },
        ServiceManaged = new ServiceManagedProperty {
            HostAddress = "hostAddress",
            SubnetIds = new [] { "subnetIds" },
            VpcId = "vpcId",

            // the properties below are optional
            DnsResolution = "dnsResolution",
            IpAddressType = "ipAddressType",
            Ipv4AddressesPerEni = 123,
            PortRanges = new [] { "portRanges" },
            SecurityGroupIds = new [] { "securityGroupIds" }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnPrivateConnectionProps := &CfnPrivateConnectionProps{
	PrivateConnectionName: jsii.String("privateConnectionName"),

	// the properties below are optional
	Certificate: jsii.String("certificate"),
	Mode: &ModeProperty{
		SelfManaged: &SelfManagedProperty{
			ResourceConfigurationId: jsii.String("resourceConfigurationId"),
		},
		ServiceManaged: &ServiceManagedProperty{
			HostAddress: jsii.String("hostAddress"),
			SubnetIds: []*string{
				jsii.String("subnetIds"),
			},
			VpcId: jsii.String("vpcId"),

			// the properties below are optional
			DnsResolution: jsii.String("dnsResolution"),
			IpAddressType: jsii.String("ipAddressType"),
			Ipv4AddressesPerEni: jsii.Number(123),
			PortRanges: []*string{
				jsii.String("portRanges"),
			},
			SecurityGroupIds: []*string{
				jsii.String("securityGroupIds"),
			},
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

certificateoptionalstringcertificateoptionalstrcertificateoptionalStringCertificateoptionalstringCertificateoptional*string#
The PEM-encoded certificate chain for the private connection.
modeoptionalIResolvable | CfnPrivateConnection.ModePropertymodeoptionaltyping.Union[IResolvable, ModeProperty]modeoptionalIResolvableModeoptionalIResolvableModeoptionalinterface{}#
The configuration for the private connection.

Specify either a service-managed or a self-managed mode.

privateConnectionNamestringprivate_connection_namestrprivateConnectionNameStringPrivateConnectionNamestringPrivateConnectionName*stringrequired#
A unique name for the private connection within your account.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags attached to the private connection.