AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

EndpointAccess

Resource schema for a Redshift-managed VPC endpoint.

Create a EndpointAccess Resource

new EndpointAccess(name: string, args: EndpointAccessArgs, opts?: CustomResourceOptions);
@overload
def EndpointAccess(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cluster_identifier: Optional[str] = None,
                   endpoint_name: Optional[str] = None,
                   resource_owner: Optional[str] = None,
                   subnet_group_name: Optional[str] = None,
                   vpc_security_group_ids: Optional[Sequence[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-native:redshift: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.

VpcSecurityGroupIds List<string>

A list of vpc security group ids to apply to the created endpoint access.

ClusterIdentifier string

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

ResourceOwner string

The AWS account ID of the owner of the cluster.

SubnetGroupName string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

EndpointName string

The name of the endpoint.

VpcSecurityGroupIds []string

A list of vpc security group ids to apply to the created endpoint access.

ClusterIdentifier string

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

ResourceOwner string

The AWS account ID of the owner of the cluster.

SubnetGroupName string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointName String

The name of the endpoint.

vpcSecurityGroupIds List<String>

A list of vpc security group ids to apply to the created endpoint access.

clusterIdentifier String

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

resourceOwner String

The AWS account ID of the owner of the cluster.

subnetGroupName String

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointName string

The name of the endpoint.

vpcSecurityGroupIds string[]

A list of vpc security group ids to apply to the created endpoint access.

clusterIdentifier string

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

resourceOwner string

The AWS account ID of the owner of the cluster.

subnetGroupName string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpoint_name str

The name of the endpoint.

vpc_security_group_ids Sequence[str]

A list of vpc security group ids to apply to the created endpoint access.

cluster_identifier str

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

resource_owner str

The AWS account ID of the owner of the cluster.

subnet_group_name str

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointName String

The name of the endpoint.

vpcSecurityGroupIds List<String>

A list of vpc security group ids to apply to the created endpoint access.

clusterIdentifier String

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account

resourceOwner String

The AWS account ID of the owner of the cluster.

subnetGroupName String

The subnet group name where Amazon Redshift chooses to deploy the 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.

EndpointCreateTime string

The time (UTC) that the endpoint was created.

EndpointStatus string

The status 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.

VpcEndpoint Pulumi.AwsNative.Redshift.Outputs.VpcEndpointProperties

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroups List<Pulumi.AwsNative.Redshift.Outputs.EndpointAccessVpcSecurityGroup>

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

Address string

The DNS address of the endpoint.

EndpointCreateTime string

The time (UTC) that the endpoint was created.

EndpointStatus string

The status 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.

VpcEndpoint VpcEndpointProperties

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroups []EndpointAccessVpcSecurityGroup

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

address String

The DNS address of the endpoint.

endpointCreateTime String

The time (UTC) that the endpoint was created.

endpointStatus String

The status 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.

vpcEndpoint VpcEndpointProperties

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

vpcSecurityGroups List<EndpointAccessVpcSecurityGroup>

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

address string

The DNS address of the endpoint.

endpointCreateTime string

The time (UTC) that the endpoint was created.

endpointStatus string

The status 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.

vpcEndpoint VpcEndpointProperties

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

vpcSecurityGroups EndpointAccessVpcSecurityGroup[]

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

address str

The DNS address of the endpoint.

endpoint_create_time str

The time (UTC) that the endpoint was created.

endpoint_status str

The status 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_endpoint VpcEndpointProperties

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

vpc_security_groups Sequence[EndpointAccessVpcSecurityGroup]

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

address String

The DNS address of the endpoint.

endpointCreateTime String

The time (UTC) that the endpoint was created.

endpointStatus String

The status 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.

vpcEndpoint Property Map

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

vpcSecurityGroups List<Property Map>

A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.

Supporting Types

EndpointAccessNetworkInterface

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.

EndpointAccessVpcSecurityGroup

Status string

The status of the VPC security group.

VpcSecurityGroupId string

The identifier of the VPC security group.

Status string

The status of the VPC security group.

VpcSecurityGroupId string

The identifier of the VPC security group.

status String

The status of the VPC security group.

vpcSecurityGroupId String

The identifier of the VPC security group.

status string

The status of the VPC security group.

vpcSecurityGroupId string

The identifier of the VPC security group.

status str

The status of the VPC security group.

vpc_security_group_id str

The identifier of the VPC security group.

status String

The status of the VPC security group.

vpcSecurityGroupId String

The identifier of the VPC security group.

VpcEndpointProperties

NetworkInterfaces List<Pulumi.AwsNative.Redshift.Inputs.EndpointAccessNetworkInterface>

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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 []EndpointAccessNetworkInterface

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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<EndpointAccessNetworkInterface>

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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 EndpointAccessNetworkInterface[]

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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[EndpointAccessNetworkInterface]

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0