1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. EndpointAccess
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.redshift.EndpointAccess

Explore with Pulumi AI

Creates a new Amazon Redshift endpoint access.

Example Usage

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

const example = new aws.redshift.EndpointAccess("example", {
    endpointName: "example",
    subnetGroupName: exampleAwsRedshiftSubnetGroup.id,
    clusterIdentifier: exampleAwsRedshiftCluster.clusterIdentifier,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.redshift.EndpointAccess("example",
    endpoint_name="example",
    subnet_group_name=example_aws_redshift_subnet_group["id"],
    cluster_identifier=example_aws_redshift_cluster["clusterIdentifier"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewEndpointAccess(ctx, "example", &redshift.EndpointAccessArgs{
			EndpointName:      pulumi.String("example"),
			SubnetGroupName:   pulumi.Any(exampleAwsRedshiftSubnetGroup.Id),
			ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.ClusterIdentifier),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.EndpointAccess("example", new()
    {
        EndpointName = "example",
        SubnetGroupName = exampleAwsRedshiftSubnetGroup.Id,
        ClusterIdentifier = exampleAwsRedshiftCluster.ClusterIdentifier,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.EndpointAccess;
import com.pulumi.aws.redshift.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")
            .subnetGroupName(exampleAwsRedshiftSubnetGroup.id())
            .clusterIdentifier(exampleAwsRedshiftCluster.clusterIdentifier())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:redshift:EndpointAccess
    properties:
      endpointName: example
      subnetGroupName: ${exampleAwsRedshiftSubnetGroup.id}
      clusterIdentifier: ${exampleAwsRedshiftCluster.clusterIdentifier}
Copy

Create EndpointAccess Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EndpointAccess(name: string, args: EndpointAccessArgs, opts?: CustomResourceOptions);
@overload
def EndpointAccess(resource_name: str,
                   args: EndpointAccessArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def EndpointAccess(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cluster_identifier: Optional[str] = None,
                   endpoint_name: Optional[str] = None,
                   subnet_group_name: Optional[str] = None,
                   resource_owner: Optional[str] = None,
                   vpc_security_group_ids: Optional[Sequence[str]] = 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:redshift:EndpointAccess
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EndpointAccessArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. EndpointAccessArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EndpointAccessArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EndpointAccessArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var endpointAccessResource = new Aws.RedShift.EndpointAccess("endpointAccessResource", new()
{
    ClusterIdentifier = "string",
    EndpointName = "string",
    SubnetGroupName = "string",
    ResourceOwner = "string",
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});
Copy
example, err := redshift.NewEndpointAccess(ctx, "endpointAccessResource", &redshift.EndpointAccessArgs{
	ClusterIdentifier: pulumi.String("string"),
	EndpointName:      pulumi.String("string"),
	SubnetGroupName:   pulumi.String("string"),
	ResourceOwner:     pulumi.String("string"),
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var endpointAccessResource = new EndpointAccess("endpointAccessResource", EndpointAccessArgs.builder()
    .clusterIdentifier("string")
    .endpointName("string")
    .subnetGroupName("string")
    .resourceOwner("string")
    .vpcSecurityGroupIds("string")
    .build());
Copy
endpoint_access_resource = aws.redshift.EndpointAccess("endpointAccessResource",
    cluster_identifier="string",
    endpoint_name="string",
    subnet_group_name="string",
    resource_owner="string",
    vpc_security_group_ids=["string"])
Copy
const endpointAccessResource = new aws.redshift.EndpointAccess("endpointAccessResource", {
    clusterIdentifier: "string",
    endpointName: "string",
    subnetGroupName: "string",
    resourceOwner: "string",
    vpcSecurityGroupIds: ["string"],
});
Copy
type: aws:redshift:EndpointAccess
properties:
    clusterIdentifier: string
    endpointName: string
    resourceOwner: string
    subnetGroupName: string
    vpcSecurityGroupIds:
        - string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EndpointAccess resource accepts the following input properties:

ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier of the cluster to access.
EndpointName
This property is required.
Changes to this property will trigger replacement.
string
The Redshift-managed VPC endpoint name.
SubnetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
ResourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
VpcSecurityGroupIds List<string>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier of the cluster to access.
EndpointName
This property is required.
Changes to this property will trigger replacement.
string
The Redshift-managed VPC endpoint name.
SubnetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
ResourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
VpcSecurityGroupIds []string
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier of the cluster to access.
endpointName
This property is required.
Changes to this property will trigger replacement.
String
The Redshift-managed VPC endpoint name.
subnetGroupName
This property is required.
Changes to this property will trigger replacement.
String
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
resourceOwner Changes to this property will trigger replacement. String
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
vpcSecurityGroupIds List<String>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier of the cluster to access.
endpointName
This property is required.
Changes to this property will trigger replacement.
string
The Redshift-managed VPC endpoint name.
subnetGroupName
This property is required.
Changes to this property will trigger replacement.
string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
resourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
vpcSecurityGroupIds string[]
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
cluster_identifier
This property is required.
Changes to this property will trigger replacement.
str
The cluster identifier of the cluster to access.
endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The Redshift-managed VPC endpoint name.
subnet_group_name
This property is required.
Changes to this property will trigger replacement.
str
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
resource_owner Changes to this property will trigger replacement. str
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
vpc_security_group_ids Sequence[str]
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier of the cluster to access.
endpointName
This property is required.
Changes to this property will trigger replacement.
String
The Redshift-managed VPC endpoint name.
subnetGroupName
This property is required.
Changes to this property will trigger replacement.
String
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
resourceOwner Changes to this property will trigger replacement. String
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
vpcSecurityGroupIds List<String>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

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 endpoint.
Id string
The provider-assigned unique ID for this managed resource.
Port int
The port number on which the cluster accepts incoming connections.
VpcEndpoints List<EndpointAccessVpcEndpoint>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
Address string
The DNS address of the endpoint.
Id string
The provider-assigned unique ID for this managed resource.
Port int
The port number on which the cluster accepts incoming connections.
VpcEndpoints []EndpointAccessVpcEndpoint
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
address String
The DNS address of the endpoint.
id String
The provider-assigned unique ID for this managed resource.
port Integer
The port number on which the cluster accepts incoming connections.
vpcEndpoints List<EndpointAccessVpcEndpoint>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
address string
The DNS address of the endpoint.
id string
The provider-assigned unique ID for this managed resource.
port number
The port number on which the cluster accepts incoming connections.
vpcEndpoints EndpointAccessVpcEndpoint[]
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
address str
The DNS address of the endpoint.
id str
The provider-assigned unique ID for this managed resource.
port int
The port number on which the cluster accepts incoming connections.
vpc_endpoints Sequence[EndpointAccessVpcEndpoint]
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
address String
The DNS address of the endpoint.
id String
The provider-assigned unique ID for this managed resource.
port Number
The port number on which the cluster accepts incoming connections.
vpcEndpoints List<Property Map>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details 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,
        cluster_identifier: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        port: Optional[int] = None,
        resource_owner: Optional[str] = None,
        subnet_group_name: Optional[str] = None,
        vpc_endpoints: Optional[Sequence[EndpointAccessVpcEndpointArgs]] = None,
        vpc_security_group_ids: Optional[Sequence[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)
resources:  _:    type: aws:redshift:EndpointAccess    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 endpoint.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier of the cluster to access.
EndpointName Changes to this property will trigger replacement. string
The Redshift-managed VPC endpoint name.
Port int
The port number on which the cluster accepts incoming connections.
ResourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
SubnetGroupName Changes to this property will trigger replacement. string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
VpcEndpoints List<EndpointAccessVpcEndpoint>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
VpcSecurityGroupIds List<string>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
Address string
The DNS address of the endpoint.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier of the cluster to access.
EndpointName Changes to this property will trigger replacement. string
The Redshift-managed VPC endpoint name.
Port int
The port number on which the cluster accepts incoming connections.
ResourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
SubnetGroupName Changes to this property will trigger replacement. string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
VpcEndpoints []EndpointAccessVpcEndpointArgs
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
VpcSecurityGroupIds []string
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
address String
The DNS address of the endpoint.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier of the cluster to access.
endpointName Changes to this property will trigger replacement. String
The Redshift-managed VPC endpoint name.
port Integer
The port number on which the cluster accepts incoming connections.
resourceOwner Changes to this property will trigger replacement. String
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
subnetGroupName Changes to this property will trigger replacement. String
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
vpcEndpoints List<EndpointAccessVpcEndpoint>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
vpcSecurityGroupIds List<String>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
address string
The DNS address of the endpoint.
clusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier of the cluster to access.
endpointName Changes to this property will trigger replacement. string
The Redshift-managed VPC endpoint name.
port number
The port number on which the cluster accepts incoming connections.
resourceOwner Changes to this property will trigger replacement. string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
subnetGroupName Changes to this property will trigger replacement. string
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
vpcEndpoints EndpointAccessVpcEndpoint[]
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
vpcSecurityGroupIds string[]
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
address str
The DNS address of the endpoint.
cluster_identifier Changes to this property will trigger replacement. str
The cluster identifier of the cluster to access.
endpoint_name Changes to this property will trigger replacement. str
The Redshift-managed VPC endpoint name.
port int
The port number on which the cluster accepts incoming connections.
resource_owner Changes to this property will trigger replacement. str
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
subnet_group_name Changes to this property will trigger replacement. str
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
vpc_endpoints Sequence[EndpointAccessVpcEndpointArgs]
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
vpc_security_group_ids Sequence[str]
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
address String
The DNS address of the endpoint.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier of the cluster to access.
endpointName Changes to this property will trigger replacement. String
The Redshift-managed VPC endpoint name.
port Number
The port number on which the cluster accepts incoming connections.
resourceOwner Changes to this property will trigger replacement. String
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
subnetGroupName Changes to this property will trigger replacement. String
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
vpcEndpoints List<Property Map>
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
vpcSecurityGroupIds List<String>
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Supporting Types

EndpointAccessVpcEndpoint
, EndpointAccessVpcEndpointArgs

NetworkInterfaces List<EndpointAccessVpcEndpointNetworkInterface>
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
VpcEndpointId string
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId string
The VPC identifier that the endpoint is associated.
NetworkInterfaces []EndpointAccessVpcEndpointNetworkInterface
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
VpcEndpointId string
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId string
The VPC identifier that the endpoint is associated.
networkInterfaces List<EndpointAccessVpcEndpointNetworkInterface>
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
vpcEndpointId String
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
vpcId String
The VPC identifier that the endpoint is associated.
networkInterfaces EndpointAccessVpcEndpointNetworkInterface[]
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
vpcEndpointId string
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
vpcId string
The VPC identifier that the endpoint is associated.
network_interfaces Sequence[EndpointAccessVpcEndpointNetworkInterface]
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
vpc_endpoint_id str
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
vpc_id str
The VPC identifier that the endpoint is associated.
networkInterfaces List<Property Map>
One or more network interfaces of the endpoint. Also known as an interface endpoint. See details below.
vpcEndpointId String
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
vpcId String
The VPC identifier that the endpoint is associated.

EndpointAccessVpcEndpointNetworkInterface
, EndpointAccessVpcEndpointNetworkInterfaceArgs

AvailabilityZone string
The Availability Zone.
NetworkInterfaceId string
The network interface identifier.
PrivateIpAddress string
The IPv4 address of the network interface within the subnet.
SubnetId string
The subnet identifier.
AvailabilityZone string
The Availability Zone.
NetworkInterfaceId string
The network interface identifier.
PrivateIpAddress string
The IPv4 address of the network interface within the subnet.
SubnetId string
The subnet identifier.
availabilityZone String
The Availability Zone.
networkInterfaceId String
The network interface identifier.
privateIpAddress String
The IPv4 address of the network interface within the subnet.
subnetId String
The subnet identifier.
availabilityZone string
The Availability Zone.
networkInterfaceId string
The network interface identifier.
privateIpAddress string
The IPv4 address of the network interface within the subnet.
subnetId string
The subnet identifier.
availability_zone str
The Availability Zone.
network_interface_id str
The network interface identifier.
private_ip_address str
The IPv4 address of the network interface within the subnet.
subnet_id str
The subnet identifier.
availabilityZone String
The Availability Zone.
networkInterfaceId String
The network interface identifier.
privateIpAddress String
The IPv4 address of the network interface within the subnet.
subnetId String
The subnet identifier.

Import

Using pulumi import, import Redshift endpoint access using the name. For example:

$ pulumi import aws:redshift/endpointAccess:EndpointAccess example example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.