Skip to content
v2.277.0

CfnNetworkConnectorProps Struct ​

Properties for defining a CfnNetworkConnector.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnNetworkConnectorProps: lambda.CfnNetworkConnectorProps = {
  configuration: {
    vpcEgressConfiguration: {
      associatedComputeResourceTypes: ['associatedComputeResourceTypes'],
      networkProtocol: 'networkProtocol',
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },

  // the properties below are optional
  name: 'name',
  operatorRole: 'operatorRole',
  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_lambda as lambda_

cfn_network_connector_props = lambda.CfnNetworkConnectorProps(
    configuration=lambda.CfnNetworkConnector.ConfigProperty(
        vpc_egress_configuration=lambda.CfnNetworkConnector.VpcEgressConfigurationProperty(
            associated_compute_resource_types=["associatedComputeResourceTypes"],
            network_protocol="networkProtocol",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    ),

    # the properties below are optional
    name="name",
    operator_role="operatorRole",
    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.lambda.*;

CfnNetworkConnectorProps cfnNetworkConnectorProps = CfnNetworkConnectorProps.builder()
        .configuration(ConfigProperty.builder()
                .vpcEgressConfiguration(VpcEgressConfigurationProperty.builder()
                        .associatedComputeResourceTypes(List.of("associatedComputeResourceTypes"))
                        .networkProtocol("networkProtocol")
                        .securityGroupIds(List.of("securityGroupIds"))
                        .subnetIds(List.of("subnetIds"))
                        .build())
                .build())

        // the properties below are optional
        .name("name")
        .operatorRole("operatorRole")
        .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.Lambda;

var cfnNetworkConnectorProps = new CfnNetworkConnectorProps {
    Configuration = new ConfigProperty {
        VpcEgressConfiguration = new VpcEgressConfigurationProperty {
            AssociatedComputeResourceTypes = new [] { "associatedComputeResourceTypes" },
            NetworkProtocol = "networkProtocol",
            SecurityGroupIds = new [] { "securityGroupIds" },
            SubnetIds = new [] { "subnetIds" }
        }
    },

    // the properties below are optional
    Name = "name",
    OperatorRole = "operatorRole",
    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"

cfnNetworkConnectorProps := &CfnNetworkConnectorProps{
	Configuration: &ConfigProperty{
		VpcEgressConfiguration: &VpcEgressConfigurationProperty{
			AssociatedComputeResourceTypes: []*string{
				jsii.String("associatedComputeResourceTypes"),
			},
			NetworkProtocol: jsii.String("networkProtocol"),
			SecurityGroupIds: []*string{
				jsii.String("securityGroupIds"),
			},
			SubnetIds: []*string{
				jsii.String("subnetIds"),
			},
		},
	},

	// the properties below are optional
	Name: jsii.String("name"),
	OperatorRole: jsii.String("operatorRole"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

configurationIResolvable | CfnNetworkConnector.ConfigPropertyconfigurationtyping.Union[IResolvable, ConfigProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#
The network configuration for the connector.

Specify a VpcEgressConfiguration to enable outbound traffic routing through your VPC.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A unique name for the network connector within your account and Region.

Must be 1 to 64 alphanumeric characters, hyphens, or underscores.

operatorRoleoptionalstringoperator_roleoptionalstroperatorRoleoptionalStringOperatorRoleoptionalstringOperatorRoleoptional*string#
The ARN of the IAM role that Lambda assumes to manage elastic network interfaces in your VPC.

This role must have permissions for ec2:CreateNetworkInterface and related describe operations.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to apply to the network connector.

Use tags to categorize network connectors for cost allocation, access control, or operational management.