1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. InstanceConnectEndpoint

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi

    Resource Type definition for AWS::EC2::InstanceConnectEndpoint

    Create InstanceConnectEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InstanceConnectEndpoint(name: string, args: InstanceConnectEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def InstanceConnectEndpoint(resource_name: str,
                                args: InstanceConnectEndpointArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def InstanceConnectEndpoint(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                subnet_id: Optional[str] = None,
                                client_token: Optional[str] = None,
                                preserve_client_ip: Optional[bool] = None,
                                security_group_ids: Optional[Sequence[str]] = None,
                                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewInstanceConnectEndpoint(ctx *Context, name string, args InstanceConnectEndpointArgs, opts ...ResourceOption) (*InstanceConnectEndpoint, error)
    public InstanceConnectEndpoint(string name, InstanceConnectEndpointArgs args, CustomResourceOptions? opts = null)
    public InstanceConnectEndpoint(String name, InstanceConnectEndpointArgs args)
    public InstanceConnectEndpoint(String name, InstanceConnectEndpointArgs args, CustomResourceOptions options)
    
    type: aws-native:ec2:InstanceConnectEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceConnectEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceConnectEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceConnectEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceConnectEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceConnectEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    InstanceConnectEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InstanceConnectEndpoint resource accepts the following input properties:

    SubnetId string
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    ClientToken string
    The client token of the instance connect endpoint.
    PreserveClientIp bool
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    SecurityGroupIds List<string>
    The security groups associated with the endpoint.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags assigned to the EC2 Instance Connect Endpoint.
    SubnetId string
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    ClientToken string
    The client token of the instance connect endpoint.
    PreserveClientIp bool
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    SecurityGroupIds []string
    The security groups associated with the endpoint.
    Tags TagArgs
    The tags assigned to the EC2 Instance Connect Endpoint.
    subnetId String
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    clientToken String
    The client token of the instance connect endpoint.
    preserveClientIp Boolean
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    securityGroupIds List<String>
    The security groups associated with the endpoint.
    tags List<Tag>
    The tags assigned to the EC2 Instance Connect Endpoint.
    subnetId string
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    clientToken string
    The client token of the instance connect endpoint.
    preserveClientIp boolean
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    securityGroupIds string[]
    The security groups associated with the endpoint.
    tags Tag[]
    The tags assigned to the EC2 Instance Connect Endpoint.
    subnet_id str
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    client_token str
    The client token of the instance connect endpoint.
    preserve_client_ip bool
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    security_group_ids Sequence[str]
    The security groups associated with the endpoint.
    tags Sequence[TagArgs]
    The tags assigned to the EC2 Instance Connect Endpoint.
    subnetId String
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
    clientToken String
    The client token of the instance connect endpoint.
    preserveClientIp Boolean
    Indicates whether your client's IP address is preserved as the source when you connect to a resource.
    securityGroupIds List<String>
    The security groups associated with the endpoint.
    tags List<Property Map>
    The tags assigned to the EC2 Instance Connect Endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InstanceConnectEndpoint resource produces the following output properties:

    AvailabilityZone string
    The Availability Zone of the EC2 Instance Connect Endpoint
    AvailabilityZoneId string
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    AwsId string
    The ID of the EC2 Instance Connect Endpoint.
    CreatedAt string
    The date and time that the EC2 Instance Connect Endpoint was created
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceConnectEndpointArn string
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    NetworkInterfaceIds List<string>
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    OwnerId string
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    PublicDnsNames Pulumi.AwsNative.Ec2.Outputs.InstanceConnectEndpointPublicDnsNames
    The public DNS names of the endpoint
    State Pulumi.AwsNative.Ec2.InstanceConnectEndpointState
    The current state of the EC2 Instance Connect Endpoint
    StateMessage string
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    VpcId string
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created
    AvailabilityZone string
    The Availability Zone of the EC2 Instance Connect Endpoint
    AvailabilityZoneId string
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    AwsId string
    The ID of the EC2 Instance Connect Endpoint.
    CreatedAt string
    The date and time that the EC2 Instance Connect Endpoint was created
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceConnectEndpointArn string
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    NetworkInterfaceIds []string
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    OwnerId string
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    PublicDnsNames InstanceConnectEndpointPublicDnsNames
    The public DNS names of the endpoint
    State InstanceConnectEndpointStateEnum
    The current state of the EC2 Instance Connect Endpoint
    StateMessage string
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    VpcId string
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created
    availabilityZone String
    The Availability Zone of the EC2 Instance Connect Endpoint
    availabilityZoneId String
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    awsId String
    The ID of the EC2 Instance Connect Endpoint.
    createdAt String
    The date and time that the EC2 Instance Connect Endpoint was created
    id String
    The provider-assigned unique ID for this managed resource.
    instanceConnectEndpointArn String
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    networkInterfaceIds List<String>
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    ownerId String
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    publicDnsNames InstanceConnectEndpointPublicDnsNames
    The public DNS names of the endpoint
    state InstanceConnectEndpointState
    The current state of the EC2 Instance Connect Endpoint
    stateMessage String
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    vpcId String
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created
    availabilityZone string
    The Availability Zone of the EC2 Instance Connect Endpoint
    availabilityZoneId string
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    awsId string
    The ID of the EC2 Instance Connect Endpoint.
    createdAt string
    The date and time that the EC2 Instance Connect Endpoint was created
    id string
    The provider-assigned unique ID for this managed resource.
    instanceConnectEndpointArn string
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    networkInterfaceIds string[]
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    ownerId string
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    publicDnsNames InstanceConnectEndpointPublicDnsNames
    The public DNS names of the endpoint
    state InstanceConnectEndpointState
    The current state of the EC2 Instance Connect Endpoint
    stateMessage string
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    vpcId string
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created
    availability_zone str
    The Availability Zone of the EC2 Instance Connect Endpoint
    availability_zone_id str
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    aws_id str
    The ID of the EC2 Instance Connect Endpoint.
    created_at str
    The date and time that the EC2 Instance Connect Endpoint was created
    id str
    The provider-assigned unique ID for this managed resource.
    instance_connect_endpoint_arn str
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    network_interface_ids Sequence[str]
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    owner_id str
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    public_dns_names InstanceConnectEndpointPublicDnsNames
    The public DNS names of the endpoint
    state InstanceConnectEndpointState
    The current state of the EC2 Instance Connect Endpoint
    state_message str
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    vpc_id str
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created
    availabilityZone String
    The Availability Zone of the EC2 Instance Connect Endpoint
    availabilityZoneId String
    The ID of the Availability Zone of the EC2 Instance Connect Endpoint
    awsId String
    The ID of the EC2 Instance Connect Endpoint.
    createdAt String
    The date and time that the EC2 Instance Connect Endpoint was created
    id String
    The provider-assigned unique ID for this managed resource.
    instanceConnectEndpointArn String
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint
    networkInterfaceIds List<String>
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint
    ownerId String
    The ID of the AWS account that created the EC2 Instance Connect Endpoint
    publicDnsNames Property Map
    The public DNS names of the endpoint
    state "create-in-progress" | "create-complete" | "create-failed" | "delete-in-progress" | "delete-complete" | "delete-failed" | "update-in-progress" | "update-complete" | "update-failed"
    The current state of the EC2 Instance Connect Endpoint
    stateMessage String
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message
    vpcId String
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created

    Supporting Types

    InstanceConnectEndpointDnsNames, InstanceConnectEndpointDnsNamesArgs

    The DNS names of the endpoint.
    DnsName string
    The DNS name of the EC2 Instance Connect Endpoint.
    FipsDnsName string
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    DnsName string
    The DNS name of the EC2 Instance Connect Endpoint.
    FipsDnsName string
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    dnsName String
    The DNS name of the EC2 Instance Connect Endpoint.
    fipsDnsName String
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    dnsName string
    The DNS name of the EC2 Instance Connect Endpoint.
    fipsDnsName string
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    dns_name str
    The DNS name of the EC2 Instance Connect Endpoint.
    fips_dns_name str
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    dnsName String
    The DNS name of the EC2 Instance Connect Endpoint.
    fipsDnsName String
    The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

    InstanceConnectEndpointPublicDnsNames, InstanceConnectEndpointPublicDnsNamesArgs

    The public DNS names of the endpoint, including IPv4-only and dualstack DNS names.
    Dualstack Pulumi.AwsNative.Ec2.Inputs.InstanceConnectEndpointDnsNames
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    Ipv4 Pulumi.AwsNative.Ec2.Inputs.InstanceConnectEndpointDnsNames
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
    Dualstack InstanceConnectEndpointDnsNames
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    Ipv4 InstanceConnectEndpointDnsNames
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
    dualstack InstanceConnectEndpointDnsNames
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    ipv4 InstanceConnectEndpointDnsNames
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
    dualstack InstanceConnectEndpointDnsNames
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    ipv4 InstanceConnectEndpointDnsNames
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
    dualstack InstanceConnectEndpointDnsNames
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    ipv4 InstanceConnectEndpointDnsNames
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.
    dualstack Property Map
    The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.
    ipv4 Property Map
    The IPv4-only DNS name of the EC2 Instance Connect Endpoint.

    InstanceConnectEndpointState, InstanceConnectEndpointStateArgs

    CreateInProgress
    create-in-progress
    CreateComplete
    create-complete
    CreateFailed
    create-failed
    DeleteInProgress
    delete-in-progress
    DeleteComplete
    delete-complete
    DeleteFailed
    delete-failed
    UpdateInProgress
    update-in-progress
    UpdateComplete
    update-complete
    UpdateFailed
    update-failed
    InstanceConnectEndpointStateCreateInProgress
    create-in-progress
    InstanceConnectEndpointStateCreateComplete
    create-complete
    InstanceConnectEndpointStateCreateFailed
    create-failed
    InstanceConnectEndpointStateDeleteInProgress
    delete-in-progress
    InstanceConnectEndpointStateDeleteComplete
    delete-complete
    InstanceConnectEndpointStateDeleteFailed
    delete-failed
    InstanceConnectEndpointStateUpdateInProgress
    update-in-progress
    InstanceConnectEndpointStateUpdateComplete
    update-complete
    InstanceConnectEndpointStateUpdateFailed
    update-failed
    CreateInProgress
    create-in-progress
    CreateComplete
    create-complete
    CreateFailed
    create-failed
    DeleteInProgress
    delete-in-progress
    DeleteComplete
    delete-complete
    DeleteFailed
    delete-failed
    UpdateInProgress
    update-in-progress
    UpdateComplete
    update-complete
    UpdateFailed
    update-failed
    CreateInProgress
    create-in-progress
    CreateComplete
    create-complete
    CreateFailed
    create-failed
    DeleteInProgress
    delete-in-progress
    DeleteComplete
    delete-complete
    DeleteFailed
    delete-failed
    UpdateInProgress
    update-in-progress
    UpdateComplete
    update-complete
    UpdateFailed
    update-failed
    CREATE_IN_PROGRESS
    create-in-progress
    CREATE_COMPLETE
    create-complete
    CREATE_FAILED
    create-failed
    DELETE_IN_PROGRESS
    delete-in-progress
    DELETE_COMPLETE
    delete-complete
    DELETE_FAILED
    delete-failed
    UPDATE_IN_PROGRESS
    update-in-progress
    UPDATE_COMPLETE
    update-complete
    UPDATE_FAILED
    update-failed
    "create-in-progress"
    create-in-progress
    "create-complete"
    create-complete
    "create-failed"
    create-failed
    "delete-in-progress"
    delete-in-progress
    "delete-complete"
    delete-complete
    "delete-failed"
    delete-failed
    "update-in-progress"
    update-in-progress
    "update-complete"
    update-complete
    "update-failed"
    update-failed

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.58.0
    published on Monday, Mar 23, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.