Create Instance Connect Endpoint

ec2_create_instance_connect_endpoint

R Documentation

Creates an EC2 Instance Connect Endpoint¶

Description¶

Creates an EC2 Instance Connect Endpoint.

An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 or public IPv6 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

Usage¶

ec2_create_instance_connect_endpoint(DryRun, SubnetId, SecurityGroupIds,
  PreserveClientIp, ClientToken, TagSpecifications, IpAddressType)

Arguments¶

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

SubnetId

[required] The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

SecurityGroupIds

One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.

PreserveClientIp

Indicates whether the client IP address is preserved as the source. The following are the possible values.

true - Use the client IP address as the source.
false - Use the network interface IP address as the source.

PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

Default: false

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

TagSpecifications

The tags to apply to the EC2 Instance Connect Endpoint during creation.

IpAddressType

The IP address type of the endpoint.

If no value is specified, the default value is determined by the IP address type of the subnet:

dualstack - If the subnet has both IPv4 and IPv6 CIDRs
ipv4 - If the subnet has only IPv4 CIDRs
ipv6 - If the subnet has only IPv6 CIDRs

PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

Value¶

A list with the following syntax:

list(
  InstanceConnectEndpoint = list(
    OwnerId = "string",
    InstanceConnectEndpointId = "string",
    InstanceConnectEndpointArn = "string",
    State = "create-in-progress"|"create-complete"|"create-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"update-in-progress"|"update-complete"|"update-failed",
    StateMessage = "string",
    DnsName = "string",
    FipsDnsName = "string",
    NetworkInterfaceIds = list(
      "string"
    ),
    VpcId = "string",
    AvailabilityZone = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    SubnetId = "string",
    PreserveClientIp = TRUE|FALSE,
    SecurityGroupIds = list(
      "string"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    IpAddressType = "ipv4"|"dualstack"|"ipv6",
    PublicDnsNames = list(
      Ipv4 = list(
        DnsName = "string",
        FipsDnsName = "string"
      ),
      Dualstack = list(
        DnsName = "string",
        FipsDnsName = "string"
      )
    ),
    AvailabilityZoneId = "string"
  ),
  ClientToken = "string"
)

Request syntax¶

svc$create_instance_connect_endpoint(
  DryRun = TRUE|FALSE,
  SubnetId = "string",
  SecurityGroupIds = list(
    "string"
  ),
  PreserveClientIp = TRUE|FALSE,
  ClientToken = "string",
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  IpAddressType = "ipv4"|"dualstack"|"ipv6"
)