AWS IoT TwinMaker and interface VPC endpoints (AWS PrivateLink)

You can establish a private connection between your virtual private cloud (VPC) and AWS IoT TwinMaker by creating an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLink, which you can use to privately access AWS IoT TwinMaker APIs without an internet gateway, network address translation (NAT) device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with AWS IoT TwinMaker APIs. Traffic between your VPC and AWS IoT TwinMaker doesn't leave the Amazon network.

Each interface endpoint is represented by one or more Elastic Network Interfaces in your subnets.

For more information, see Interface VPC endpoints (AWS PrivateLink) in the Amazon VPC User Guide.

Considerations for AWS IoT TwinMaker VPC endpoints

Before you set up an interface VPC endpoint for AWS IoT TwinMaker, review Interface endpoint properties and limitations in the Amazon VPC User Guide.

AWS IoT TwinMaker supports making calls to all of its API actions from your VPC.

• For data plane API operations, use the following endpoint:

  data.iottwinmaker.region.amazonaws.com

  The data plane API operations include the following:

  • GetPropertyValue

  • GetPropertyValueHistory

  • BatchPutPropertyValues

• For the control plane API operations, use the following endpoint:

  api.iottwinmaker.region.amazonaws.com

  The supported control plane API operations include the following:

  • CreateComponentType

  • CreateEntity

  • CreateScene

  • CreateWorkspace

  • DeleteComponentType

  • DeleteEntity

  • DeleteScene

  • DeleteWorkspace

  • GetComponentType

  • GetEntity

  • GetScene

  • GetWorkspace

  • ListComponentTypes

  • ListComponentTypes

  • ListEntities

  • ListScenes

  • ListTagsForResource

  • ListWorkspaces

  • TagResource

  • UntagResource

  • UpdateComponentType

  • UpdateEntity

  • UpdateScene

  • UpdateWorkspace

Creating an interface VPC endpoint for AWS IoT TwinMaker

You can create a VPC endpoint for the AWS IoT TwinMaker service by using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Creating an interface endpoint in the Amazon VPC User Guide.

Create a VPC endpoint for AWS IoT TwinMaker that uses the following service name.

• For data plane API operations, use the following service name:

  com.amazonaws.region.iottwinmaker.data

• For control plane API operations, use the following service name:

  com.amazonaws.region.iottwinmaker.api

If you enable private DNS for the endpoint, you can make API requests to AWS IoT TwinMaker by using its default DNS name for the Region, for example, iottwinmaker.us-east-1.amazonaws.com.

For more information, see Accessing a service through an interface endpoint in the Amazon VPC User Guide.

AWS IoT TwinMaker PrivateLink is supported in the following regions:

• us-east-1

  The ControlPlane service is supported in the following availability zones: use1-az1, use1-az2, and use1-az6.

  The DataPlane service is supported in the following availability zones: use1-az1, use1-az2, and use1-az4.

• us-west-2

  The ControlPlane and DataPlane services are supported in the following availability zones: usw2-az1, usw2-az2, and usw2-az3.

• eu-west-1

• eu-central-1

• ap-southeast-1

• ap-southeast-2

For more information on availability zones, see Availability Zone IDs for your AWS resources - AWS Resource Access Manager.

Accessing AWS IoT TwinMaker through an interface VPC endpoint

When you create an interface endpoint, AWS IoT TwinMaker generates endpoint-specific DNS hostnames that you can use to communicate with AWS IoT TwinMaker. The private DNS option is enabled by default. For more information, see Using private hosted zones in the Amazon VPC User Guide.

If you enable private DNS for the endpoint, you can make API requests to AWS IoT TwinMaker through one of the following VPC endpoints.

• For the data plane API operations, use the following endpoint. Replace region with your AWS Region.

  data.iottwinmaker.region.amazonaws.com

• For the control plane API operations, use the following endpoint. Replace region with your AWS Region.

  api.iottwinmaker.region.amazonaws.com

If you disable private DNS for the endpoint, you must do the following to access AWS IoT TwinMaker through the endpoint:

• Specify the VPC endpoint URL in API requests.

  • For the data plane API operations, use the following endpoint URL. Replace vpc-endpoint-id and region with your VPC endpoint ID and Region.

    vpc-endpoint-id.data.iottwinmaker.region.vpce.amazonaws.com

  • For the control plane API operations, use the following endpoint URL. Replace vpc-endpoint-id and region with your VPC endpoint ID and Region.

    vpc-endpoint-id.api.iottwinmaker.region.vpce.amazonaws.com

• Disable host prefix injection. The AWS CLI and AWS SDKs prepend the service endpoint with various host prefixes when you call each API operation. This causes the AWS CLI and AWS SDKs to produce invalid URLs for AWS IoT TwinMaker when you specify a VPC endpoint.

  Important

  You can't disable host prefix injection in AWS CLI or AWS Tools for PowerShell. This means that if you've disabled private DNS, you won't be able to use AWS CLI or AWS Tools for PowerShell to access AWS IoT TwinMaker through the VPC endpoint. If you want to use these tools to access AWS IoT TwinMaker through the endpoint, enable private DNS.

  For more information about how to disable host prefix injection in the AWS SDKs, see the following documentation sections for each SDK:

  • AWS SDK for C++

  • AWS SDK for Go

  • AWS SDK for Go v2

  • AWS SDK for Java

  • AWS SDK for Java 2.x

  • AWS SDK for JavaScript

  • AWS SDK for .NET

  • AWS SDK for PHP

  • AWS SDK for Python (Boto3)

  • AWS SDK for Ruby

For more information, see Accessing a service through an interface endpoint in the Amazon VPC User Guide.

Creating a VPC endpoint policy for AWS IoT TwinMaker

You can attach an endpoint policy to your VPC endpoint that controls access to AWS IoT TwinMaker. The policy specifies the following information:

• The principal that can perform actions.

• The actions that can be performed.

• The resources on which actions can be performed.

For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide.

Example: VPC endpoint policy for AWS IoT TwinMaker actions

The following is an example of an endpoint policy for AWS IoT TwinMaker. When attached to an endpoint, this policy grants access to the listed AWS IoT TwinMaker actions for the IAM user iottwinmakeradmin in the AWS account 123456789012 on all resources.

{
   "Statement":[ 
      {
        "Principal": {
            "AWS": "arn:aws:iam::123456789012:user/role"
                },
         "Resource": "*",
         "Effect":"Allow",
         "Action":[
            "iottwinmaker:CreateEntity",
            "iottwinmaker:GetScene",
            "iottwinmaker:ListEntities"
         ]
        }
    ]
}