Create Verified Access Endpoint

ec2_create_verified_access_endpoint

R Documentation

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy¶

Description¶

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Usage¶

ec2_create_verified_access_endpoint(VerifiedAccessGroupId, EndpointType,
  AttachmentType, DomainCertificateArn, ApplicationDomain,
  EndpointDomainPrefix, SecurityGroupIds, LoadBalancerOptions,
  NetworkInterfaceOptions, Description, PolicyDocument, TagSpecifications,
  ClientToken, DryRun, SseSpecification, RdsOptions, CidrOptions)

Arguments¶

VerifiedAccessGroupId

[required] The ID of the Verified Access group to associate the endpoint with.

EndpointType

[required] The type of Verified Access endpoint to create.

AttachmentType

[required] The type of attachment.

DomainCertificateArn

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.

ApplicationDomain

The DNS name for users to reach your application.

EndpointDomainPrefix

A custom identifier that is prepended to the DNS name that is generated for the endpoint.

SecurityGroupIds

The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.

LoadBalancerOptions

The load balancer details. This parameter is required if the endpoint type is load-balancer.

NetworkInterfaceOptions

The network interface details. This parameter is required if the endpoint type is network-interface.

Description

A description for the Verified Access endpoint.

PolicyDocument

The Verified Access policy document.

TagSpecifications

The tags to assign to the Verified Access endpoint.

ClientToken

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

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.

SseSpecification

The options for server side encryption.

RdsOptions

The RDS details. This parameter is required if the endpoint type is rds.

CidrOptions

The CIDR options. This parameter is required if the endpoint type is cidr.

Value¶

A list with the following syntax:

list(
  VerifiedAccessEndpoint = list(
    VerifiedAccessInstanceId = "string",
    VerifiedAccessGroupId = "string",
    VerifiedAccessEndpointId = "string",
    ApplicationDomain = "string",
    EndpointType = "load-balancer"|"network-interface"|"rds"|"cidr",
    AttachmentType = "vpc",
    DomainCertificateArn = "string",
    EndpointDomain = "string",
    DeviceValidationDomain = "string",
    SecurityGroupIds = list(
      "string"
    ),
    LoadBalancerOptions = list(
      Protocol = "http"|"https"|"tcp",
      Port = 123,
      LoadBalancerArn = "string",
      SubnetIds = list(
        "string"
      ),
      PortRanges = list(
        list(
          FromPort = 123,
          ToPort = 123
        )
      )
    ),
    NetworkInterfaceOptions = list(
      NetworkInterfaceId = "string",
      Protocol = "http"|"https"|"tcp",
      Port = 123,
      PortRanges = list(
        list(
          FromPort = 123,
          ToPort = 123
        )
      )
    ),
    Status = list(
      Code = "pending"|"active"|"updating"|"deleting"|"deleted",
      Message = "string"
    ),
    Description = "string",
    CreationTime = "string",
    LastUpdatedTime = "string",
    DeletionTime = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    SseSpecification = list(
      CustomerManagedKeyEnabled = TRUE|FALSE,
      KmsKeyArn = "string"
    ),
    RdsOptions = list(
      Protocol = "http"|"https"|"tcp",
      Port = 123,
      RdsDbInstanceArn = "string",
      RdsDbClusterArn = "string",
      RdsDbProxyArn = "string",
      RdsEndpoint = "string",
      SubnetIds = list(
        "string"
      )
    ),
    CidrOptions = list(
      Cidr = "string",
      PortRanges = list(
        list(
          FromPort = 123,
          ToPort = 123
        )
      ),
      Protocol = "http"|"https"|"tcp",
      SubnetIds = list(
        "string"
      )
    )
  )
)

Request syntax¶

svc$create_verified_access_endpoint(
  VerifiedAccessGroupId = "string",
  EndpointType = "load-balancer"|"network-interface"|"rds"|"cidr",
  AttachmentType = "vpc",
  DomainCertificateArn = "string",
  ApplicationDomain = "string",
  EndpointDomainPrefix = "string",
  SecurityGroupIds = list(
    "string"
  ),
  LoadBalancerOptions = list(
    Protocol = "http"|"https"|"tcp",
    Port = 123,
    LoadBalancerArn = "string",
    SubnetIds = list(
      "string"
    ),
    PortRanges = list(
      list(
        FromPort = 123,
        ToPort = 123
      )
    )
  ),
  NetworkInterfaceOptions = list(
    NetworkInterfaceId = "string",
    Protocol = "http"|"https"|"tcp",
    Port = 123,
    PortRanges = list(
      list(
        FromPort = 123,
        ToPort = 123
      )
    )
  ),
  Description = "string",
  PolicyDocument = "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"|"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"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  ClientToken = "string",
  DryRun = TRUE|FALSE,
  SseSpecification = list(
    CustomerManagedKeyEnabled = TRUE|FALSE,
    KmsKeyArn = "string"
  ),
  RdsOptions = list(
    Protocol = "http"|"https"|"tcp",
    Port = 123,
    RdsDbInstanceArn = "string",
    RdsDbClusterArn = "string",
    RdsDbProxyArn = "string",
    RdsEndpoint = "string",
    SubnetIds = list(
      "string"
    )
  ),
  CidrOptions = list(
    Protocol = "http"|"https"|"tcp",
    SubnetIds = list(
      "string"
    ),
    Cidr = "string",
    PortRanges = list(
      list(
        FromPort = 123,
        ToPort = 123
      )
    )
  )
)