Skip to content

Create Endpoint Access

redshiftserverless_create_endpoint_access R Documentation

Creates an Amazon Redshift Serverless managed VPC endpoint

Description

Creates an Amazon Redshift Serverless managed VPC endpoint.

Usage

redshiftserverless_create_endpoint_access(endpointName, ownerAccount,
  subnetIds, vpcSecurityGroupIds, workgroupName)

Arguments

endpointName

[required] The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

ownerAccount

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

subnetIds

[required] The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

vpcSecurityGroupIds

The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

workgroupName

[required] The name of the workgroup to associate with the VPC endpoint.

Value

A list with the following syntax: 

list(
  endpoint = list(
    address = "string",
    endpointArn = "string",
    endpointCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    endpointName = "string",
    endpointStatus = "string",
    port = 123,
    subnetIds = list(
      "string"
    ),
    vpcEndpoint = list(
      networkInterfaces = list(
        list(
          availabilityZone = "string",
          ipv6Address = "string",
          networkInterfaceId = "string",
          privateIpAddress = "string",
          subnetId = "string"
        )
      ),
      vpcEndpointId = "string",
      vpcId = "string"
    ),
    vpcSecurityGroups = list(
      list(
        status = "string",
        vpcSecurityGroupId = "string"
      )
    ),
    workgroupName = "string"
  )
)

Request syntax

svc$create_endpoint_access(
  endpointName = "string",
  ownerAccount = "string",
  subnetIds = list(
    "string"
  ),
  vpcSecurityGroupIds = list(
    "string"
  ),
  workgroupName = "string"
)