Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. redshiftserverless
  5. EndpointAccess

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.redshiftserverless.EndpointAccess

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    Creates a new Amazon Redshift Serverless Endpoint Access.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedshiftServerless.EndpointAccess("example", new()
    {
        EndpointName = "example",
        WorkgroupName = "example",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshiftserverless"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshiftserverless.NewEndpointAccess(ctx, "example", &redshiftserverless.EndpointAccessArgs{
			EndpointName:  pulumi.String("example"),
			WorkgroupName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.EndpointAccess;
import com.pulumi.aws.redshiftserverless.EndpointAccessArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new EndpointAccess("example", EndpointAccessArgs.builder()        
            .endpointName("example")
            .workgroupName("example")
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.redshiftserverless.EndpointAccess("example",
    endpoint_name="example",
    workgroup_name="example")

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshiftserverless.EndpointAccess("example", {
    endpointName: "example",
    workgroupName: "example",
});

    resources:
  example:
    type: aws:redshiftserverless:EndpointAccess
    properties:
      endpointName: example
      workgroupName: example

    Create EndpointAccess Resource

    new EndpointAccess(name: string, args: EndpointAccessArgs, opts?: CustomResourceOptions);
    @overload
def EndpointAccess(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   endpoint_name: Optional[str] = None,
                   subnet_ids: Optional[Sequence[str]] = None,
                   vpc_security_group_ids: Optional[Sequence[str]] = None,
                   workgroup_name: Optional[str] = None)
@overload
def EndpointAccess(resource_name: str,
                   args: EndpointAccessArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewEndpointAccess(ctx *Context, name string, args EndpointAccessArgs, opts ...ResourceOption) (*EndpointAccess, error)
    public EndpointAccess(string name, EndpointAccessArgs args, CustomResourceOptions? opts = null)
    public EndpointAccess(String name, EndpointAccessArgs args)
public EndpointAccess(String name, EndpointAccessArgs args, CustomResourceOptions options)

    type: aws:redshiftserverless:EndpointAccess
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EndpointAccessArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EndpointAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointAccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EndpointAccess Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EndpointAccess resource accepts the following input properties:

    EndpointName string

    The name of the endpoint.

    SubnetIds List<string>

    An array of VPC subnet IDs to associate with the endpoint.

    WorkgroupName string

    The name of the workgroup.

    VpcSecurityGroupIds List<string>

    An array of security group IDs to associate with the workgroup.

    EndpointName string

    The name of the endpoint.

    SubnetIds []string

    An array of VPC subnet IDs to associate with the endpoint.

    WorkgroupName string

    The name of the workgroup.

    VpcSecurityGroupIds []string

    An array of security group IDs to associate with the workgroup.

    endpointName String

    The name of the endpoint.

    subnetIds List<String>

    An array of VPC subnet IDs to associate with the endpoint.

    workgroupName String

    The name of the workgroup.

    vpcSecurityGroupIds List<String>

    An array of security group IDs to associate with the workgroup.

    endpointName string

    The name of the endpoint.

    subnetIds string[]

    An array of VPC subnet IDs to associate with the endpoint.

    workgroupName string

    The name of the workgroup.

    vpcSecurityGroupIds string[]

    An array of security group IDs to associate with the workgroup.

    endpoint_name str

    The name of the endpoint.

    subnet_ids Sequence[str]

    An array of VPC subnet IDs to associate with the endpoint.

    workgroup_name str

    The name of the workgroup.

    vpc_security_group_ids Sequence[str]

    An array of security group IDs to associate with the workgroup.

    endpointName String

    The name of the endpoint.

    subnetIds List<String>

    An array of VPC subnet IDs to associate with the endpoint.

    workgroupName String

    The name of the workgroup.

    vpcSecurityGroupIds List<String>

    An array of security group IDs to associate with the workgroup.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EndpointAccess resource produces the following output properties:

    Address string

    The DNS address of the VPC endpoint.

    Arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    Id string

    The provider-assigned unique ID for this managed resource.

    Port int

    The port that Amazon Redshift Serverless listens on.

    VpcEndpoints List<EndpointAccessVpcEndpoint>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    Address string

    The DNS address of the VPC endpoint.

    Arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    Id string

    The provider-assigned unique ID for this managed resource.

    Port int

    The port that Amazon Redshift Serverless listens on.

    VpcEndpoints []EndpointAccessVpcEndpoint

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    address String

    The DNS address of the VPC endpoint.

    arn String

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    id String

    The provider-assigned unique ID for this managed resource.

    port Integer

    The port that Amazon Redshift Serverless listens on.

    vpcEndpoints List<EndpointAccessVpcEndpoint>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    address string

    The DNS address of the VPC endpoint.

    arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    id string

    The provider-assigned unique ID for this managed resource.

    port number

    The port that Amazon Redshift Serverless listens on.

    vpcEndpoints EndpointAccessVpcEndpoint[]

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    address str

    The DNS address of the VPC endpoint.

    arn str

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    id str

    The provider-assigned unique ID for this managed resource.

    port int

    The port that Amazon Redshift Serverless listens on.

    vpc_endpoints Sequence[EndpointAccessVpcEndpoint]

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    address String

    The DNS address of the VPC endpoint.

    arn String

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    id String

    The provider-assigned unique ID for this managed resource.

    port Number

    The port that Amazon Redshift Serverless listens on.

    vpcEndpoints List<Property Map>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    Look up Existing EndpointAccess Resource

    Get an existing EndpointAccess resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EndpointAccessState, opts?: CustomResourceOptions): EndpointAccess
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        arn: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        port: Optional[int] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        vpc_endpoints: Optional[Sequence[EndpointAccessVpcEndpointArgs]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None,
        workgroup_name: Optional[str] = None) -> EndpointAccess
    func GetEndpointAccess(ctx *Context, name string, id IDInput, state *EndpointAccessState, opts ...ResourceOption) (*EndpointAccess, error)
    public static EndpointAccess Get(string name, Input<string> id, EndpointAccessState? state, CustomResourceOptions? opts = null)
    public static EndpointAccess get(String name, Output<String> id, EndpointAccessState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Address string

    The DNS address of the VPC endpoint.

    Arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    EndpointName string

    The name of the endpoint.

    Port int

    The port that Amazon Redshift Serverless listens on.

    SubnetIds List<string>

    An array of VPC subnet IDs to associate with the endpoint.

    VpcEndpoints List<EndpointAccessVpcEndpoint>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    VpcSecurityGroupIds List<string>

    An array of security group IDs to associate with the workgroup.

    WorkgroupName string

    The name of the workgroup.

    Address string

    The DNS address of the VPC endpoint.

    Arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    EndpointName string

    The name of the endpoint.

    Port int

    The port that Amazon Redshift Serverless listens on.

    SubnetIds []string

    An array of VPC subnet IDs to associate with the endpoint.

    VpcEndpoints []EndpointAccessVpcEndpointArgs

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    VpcSecurityGroupIds []string

    An array of security group IDs to associate with the workgroup.

    WorkgroupName string

    The name of the workgroup.

    address String

    The DNS address of the VPC endpoint.

    arn String

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    endpointName String

    The name of the endpoint.

    port Integer

    The port that Amazon Redshift Serverless listens on.

    subnetIds List<String>

    An array of VPC subnet IDs to associate with the endpoint.

    vpcEndpoints List<EndpointAccessVpcEndpoint>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    vpcSecurityGroupIds List<String>

    An array of security group IDs to associate with the workgroup.

    workgroupName String

    The name of the workgroup.

    address string

    The DNS address of the VPC endpoint.

    arn string

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    endpointName string

    The name of the endpoint.

    port number

    The port that Amazon Redshift Serverless listens on.

    subnetIds string[]

    An array of VPC subnet IDs to associate with the endpoint.

    vpcEndpoints EndpointAccessVpcEndpoint[]

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    vpcSecurityGroupIds string[]

    An array of security group IDs to associate with the workgroup.

    workgroupName string

    The name of the workgroup.

    address str

    The DNS address of the VPC endpoint.

    arn str

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    endpoint_name str

    The name of the endpoint.

    port int

    The port that Amazon Redshift Serverless listens on.

    subnet_ids Sequence[str]

    An array of VPC subnet IDs to associate with the endpoint.

    vpc_endpoints Sequence[EndpointAccessVpcEndpointArgs]

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    vpc_security_group_ids Sequence[str]

    An array of security group IDs to associate with the workgroup.

    workgroup_name str

    The name of the workgroup.

    address String

    The DNS address of the VPC endpoint.

    arn String

    Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.

    endpointName String

    The name of the endpoint.

    port Number

    The port that Amazon Redshift Serverless listens on.

    subnetIds List<String>

    An array of VPC subnet IDs to associate with the endpoint.

    vpcEndpoints List<Property Map>

    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    vpcSecurityGroupIds List<String>

    An array of security group IDs to associate with the workgroup.

    workgroupName String

    The name of the workgroup.

    Supporting Types

    EndpointAccessVpcEndpoint, EndpointAccessVpcEndpointArgs

    NetworkInterfaces List<EndpointAccessVpcEndpointNetworkInterface>

    The network interfaces of the endpoint.. See Network Interface below.

    VpcEndpointId string

    The DNS address of the VPC endpoint.

    VpcId string

    The port that Amazon Redshift Serverless listens on.

    NetworkInterfaces []EndpointAccessVpcEndpointNetworkInterface

    The network interfaces of the endpoint.. See Network Interface below.

    VpcEndpointId string

    The DNS address of the VPC endpoint.

    VpcId string

    The port that Amazon Redshift Serverless listens on.

    networkInterfaces List<EndpointAccessVpcEndpointNetworkInterface>

    The network interfaces of the endpoint.. See Network Interface below.

    vpcEndpointId String

    The DNS address of the VPC endpoint.

    vpcId String

    The port that Amazon Redshift Serverless listens on.

    networkInterfaces EndpointAccessVpcEndpointNetworkInterface[]

    The network interfaces of the endpoint.. See Network Interface below.

    vpcEndpointId string

    The DNS address of the VPC endpoint.

    vpcId string

    The port that Amazon Redshift Serverless listens on.

    network_interfaces Sequence[EndpointAccessVpcEndpointNetworkInterface]

    The network interfaces of the endpoint.. See Network Interface below.

    vpc_endpoint_id str

    The DNS address of the VPC endpoint.

    vpc_id str

    The port that Amazon Redshift Serverless listens on.

    networkInterfaces List<Property Map>

    The network interfaces of the endpoint.. See Network Interface below.

    vpcEndpointId String

    The DNS address of the VPC endpoint.

    vpcId String

    The port that Amazon Redshift Serverless listens on.

    EndpointAccessVpcEndpointNetworkInterface, EndpointAccessVpcEndpointNetworkInterfaceArgs

    AvailabilityZone string

    The availability Zone.

    NetworkInterfaceId string

    The unique identifier of the network interface.

    PrivateIpAddress string

    The IPv4 address of the network interface within the subnet.

    SubnetId string

    The unique identifier of the subnet.

    AvailabilityZone string

    The availability Zone.

    NetworkInterfaceId string

    The unique identifier of the network interface.

    PrivateIpAddress string

    The IPv4 address of the network interface within the subnet.

    SubnetId string

    The unique identifier of the subnet.

    availabilityZone String

    The availability Zone.

    networkInterfaceId String

    The unique identifier of the network interface.

    privateIpAddress String

    The IPv4 address of the network interface within the subnet.

    subnetId String

    The unique identifier of the subnet.

    availabilityZone string

    The availability Zone.

    networkInterfaceId string

    The unique identifier of the network interface.

    privateIpAddress string

    The IPv4 address of the network interface within the subnet.

    subnetId string

    The unique identifier of the subnet.

    availability_zone str

    The availability Zone.

    network_interface_id str

    The unique identifier of the network interface.

    private_ip_address str

    The IPv4 address of the network interface within the subnet.

    subnet_id str

    The unique identifier of the subnet.

    availabilityZone String

    The availability Zone.

    networkInterfaceId String

    The unique identifier of the network interface.

    privateIpAddress String

    The IPv4 address of the network interface within the subnet.

    subnetId String

    The unique identifier of the subnet.

    Import

    Using pulumi import, import Redshift Serverless Endpoint Access using the endpoint_name. For example:

     $ pulumi import aws:redshiftserverless/endpointAccess:EndpointAccess example example

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws