CreateVerifiedAccessInstanceCommand

Suggest an Edit

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, CreateVerifiedAccessInstanceCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, CreateVerifiedAccessInstanceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // CreateVerifiedAccessInstanceRequest
  Description: "STRING_VALUE",
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      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" || "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" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "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-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" || "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",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  ClientToken: "STRING_VALUE",
  DryRun: true || false,
  FIPSEnabled: true || false,
  CidrEndpointsCustomSubDomain: "STRING_VALUE",
};
const command = new CreateVerifiedAccessInstanceCommand(input);
const response = await client.send(command);
// { // CreateVerifiedAccessInstanceResult
//   VerifiedAccessInstance: { // VerifiedAccessInstance
//     VerifiedAccessInstanceId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     VerifiedAccessTrustProviders: [ // VerifiedAccessTrustProviderCondensedList
//       { // VerifiedAccessTrustProviderCondensed
//         VerifiedAccessTrustProviderId: "STRING_VALUE",
//         Description: "STRING_VALUE",
//         TrustProviderType: "user" || "device",
//         UserTrustProviderType: "iam-identity-center" || "oidc",
//         DeviceTrustProviderType: "jamf" || "crowdstrike" || "jumpcloud",
//       },
//     ],
//     CreationTime: "STRING_VALUE",
//     LastUpdatedTime: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     FipsEnabled: true || false,
//     CidrEndpointsCustomSubDomain: { // VerifiedAccessInstanceCustomSubDomain
//       SubDomain: "STRING_VALUE",
//       Nameservers: [ // ValueStringList
//         "STRING_VALUE",
//       ],
//     },
//   },
// };

CreateVerifiedAccessInstanceCommand Input

See CreateVerifiedAccessInstanceCommandInput for more details

Parameter
Type
Description
CidrEndpointsCustomSubDomain
string | undefined

The custom subdomain.

ClientToken
string | undefined

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency .

Description
string | undefined

A description for the Verified Access instance.

DryRun
boolean | undefined

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.

FIPSEnabled
boolean | undefined

Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.

TagSpecifications
TagSpecification[] | undefined

The tags to assign to the Verified Access instance.

CreateVerifiedAccessInstanceCommand Output

See CreateVerifiedAccessInstanceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
VerifiedAccessInstance
VerifiedAccessInstance | undefined

Details about the Verified Access instance.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.