Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. redshift
  5. getEndpointAccess

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.redshift.getEndpointAccess

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for a Redshift-managed VPC endpoint.

    Using getEndpointAccess

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpointAccess(args: GetEndpointAccessArgs, opts?: InvokeOptions): Promise<GetEndpointAccessResult>
function getEndpointAccessOutput(args: GetEndpointAccessOutputArgs, opts?: InvokeOptions): Output<GetEndpointAccessResult>
    def get_endpoint_access(endpoint_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEndpointAccessResult
def get_endpoint_access_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEndpointAccessResult]
    func LookupEndpointAccess(ctx *Context, args *LookupEndpointAccessArgs, opts ...InvokeOption) (*LookupEndpointAccessResult, error)
func LookupEndpointAccessOutput(ctx *Context, args *LookupEndpointAccessOutputArgs, opts ...InvokeOption) LookupEndpointAccessResultOutput

    > Note: This function is named LookupEndpointAccess in the Go SDK.

    public static class GetEndpointAccess 
{
    public static Task<GetEndpointAccessResult> InvokeAsync(GetEndpointAccessArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointAccessResult> Invoke(GetEndpointAccessInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointAccessResult> getEndpointAccess(GetEndpointAccessArgs args, InvokeOptions options)
public static Output<GetEndpointAccessResult> getEndpointAccess(GetEndpointAccessArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:redshift:getEndpointAccess
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EndpointName string
    The name of the endpoint.
    EndpointName string
    The name of the endpoint.
    endpointName String
    The name of the endpoint.
    endpointName string
    The name of the endpoint.
    endpoint_name str
    The name of the endpoint.
    endpointName String
    The name of the endpoint.

    getEndpointAccess Result

    The following output properties are available:

    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.
    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.
    VpcSecurityGroupIds List<string>
    A list of vpc security group ids to apply to the created endpoint access.
    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.
    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.
    VpcSecurityGroupIds []string
    A list of vpc security group ids to apply to the created endpoint access.
    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.
    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.
    vpcSecurityGroupIds List<String>
    A list of vpc security group ids to apply to the created endpoint access.
    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.
    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.
    vpcSecurityGroupIds string[]
    A list of vpc security group ids to apply to the created endpoint access.
    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.
    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_group_ids Sequence[str]
    A list of vpc security group ids to apply to the created endpoint access.
    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.
    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.
    vpcSecurityGroupIds List<String>
    A list of vpc security group ids to apply to the created endpoint access.
    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
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native