1. Packages
  2. AWS
  3. API Docs
  4. vpc
  5. getVpcEndpointAssociations
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi

aws.vpc.getVpcEndpointAssociations

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi

    Data source for managing an AWS EC2 (Elastic Compute Cloud) Vpc Endpoint Associations.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.vpc.getVpcEndpointAssociations({
        vpcEndpointId: exampleAwsVpcEndpoint.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.vpc.get_vpc_endpoint_associations(vpc_endpoint_id=example_aws_vpc_endpoint["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vpc.GetVpcEndpointAssociations(ctx, &vpc.GetVpcEndpointAssociationsArgs{
    			VpcEndpointId: exampleAwsVpcEndpoint.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Vpc.GetVpcEndpointAssociations.Invoke(new()
        {
            VpcEndpointId = exampleAwsVpcEndpoint.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.vpc.VpcFunctions;
    import com.pulumi.aws.vpc.inputs.GetVpcEndpointAssociationsArgs;
    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) {
            final var example = VpcFunctions.getVpcEndpointAssociations(GetVpcEndpointAssociationsArgs.builder()
                .vpcEndpointId(exampleAwsVpcEndpoint.id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:vpc:getVpcEndpointAssociations
          arguments:
            vpcEndpointId: ${exampleAwsVpcEndpoint.id}
    

    Using getVpcEndpointAssociations

    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 getVpcEndpointAssociations(args: GetVpcEndpointAssociationsArgs, opts?: InvokeOptions): Promise<GetVpcEndpointAssociationsResult>
    function getVpcEndpointAssociationsOutput(args: GetVpcEndpointAssociationsOutputArgs, opts?: InvokeOptions): Output<GetVpcEndpointAssociationsResult>
    def get_vpc_endpoint_associations(vpc_endpoint_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetVpcEndpointAssociationsResult
    def get_vpc_endpoint_associations_output(vpc_endpoint_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetVpcEndpointAssociationsResult]
    func GetVpcEndpointAssociations(ctx *Context, args *GetVpcEndpointAssociationsArgs, opts ...InvokeOption) (*GetVpcEndpointAssociationsResult, error)
    func GetVpcEndpointAssociationsOutput(ctx *Context, args *GetVpcEndpointAssociationsOutputArgs, opts ...InvokeOption) GetVpcEndpointAssociationsResultOutput

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

    public static class GetVpcEndpointAssociations 
    {
        public static Task<GetVpcEndpointAssociationsResult> InvokeAsync(GetVpcEndpointAssociationsArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcEndpointAssociationsResult> Invoke(GetVpcEndpointAssociationsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcEndpointAssociationsResult> getVpcEndpointAssociations(GetVpcEndpointAssociationsArgs args, InvokeOptions options)
    public static Output<GetVpcEndpointAssociationsResult> getVpcEndpointAssociations(GetVpcEndpointAssociationsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:vpc/getVpcEndpointAssociations:getVpcEndpointAssociations
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VpcEndpointId string
    ID of the specific VPC Endpoint to retrieve.
    VpcEndpointId string
    ID of the specific VPC Endpoint to retrieve.
    vpcEndpointId String
    ID of the specific VPC Endpoint to retrieve.
    vpcEndpointId string
    ID of the specific VPC Endpoint to retrieve.
    vpc_endpoint_id str
    ID of the specific VPC Endpoint to retrieve.
    vpcEndpointId String
    ID of the specific VPC Endpoint to retrieve.

    getVpcEndpointAssociations Result

    The following output properties are available:

    Associations List<GetVpcEndpointAssociationsAssociation>
    Associations for the VPC Endpoint. Association blocks are documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    VpcEndpointId string
    Associations []GetVpcEndpointAssociationsAssociation
    Associations for the VPC Endpoint. Association blocks are documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    VpcEndpointId string
    associations List<GetVpcEndpointAssociationsAssociation>
    Associations for the VPC Endpoint. Association blocks are documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    vpcEndpointId String
    associations GetVpcEndpointAssociationsAssociation[]
    Associations for the VPC Endpoint. Association blocks are documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    vpcEndpointId string
    associations Sequence[GetVpcEndpointAssociationsAssociation]
    Associations for the VPC Endpoint. Association blocks are documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    vpc_endpoint_id str
    associations List<Property Map>
    Associations for the VPC Endpoint. Association blocks are documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    vpcEndpointId String

    Supporting Types

    GetVpcEndpointAssociationsAssociation

    AssociatedResourceAccessibility string
    Accessibility of the resource.
    AssociatedResourceArn string
    ARN of the resource for this association.
    DnsEntries List<GetVpcEndpointAssociationsAssociationDnsEntry>
    DNS entries for the Association. DNS entry blocks are documented below.
    Id string
    PrivateDnsEntries List<GetVpcEndpointAssociationsAssociationPrivateDnsEntry>
    DNS entries for the Association. Private DNS entry blocks are documented below.
    ResourceConfigurationGroupArn string
    ARN of the Resource Group if the Resource is a member of a group.
    ServiceNetworkArn string
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    ServiceNetworkName string
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    Tags Dictionary<string, string>
    Tags of the association.
    AssociatedResourceAccessibility string
    Accessibility of the resource.
    AssociatedResourceArn string
    ARN of the resource for this association.
    DnsEntries []GetVpcEndpointAssociationsAssociationDnsEntry
    DNS entries for the Association. DNS entry blocks are documented below.
    Id string
    PrivateDnsEntries []GetVpcEndpointAssociationsAssociationPrivateDnsEntry
    DNS entries for the Association. Private DNS entry blocks are documented below.
    ResourceConfigurationGroupArn string
    ARN of the Resource Group if the Resource is a member of a group.
    ServiceNetworkArn string
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    ServiceNetworkName string
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    Tags map[string]string
    Tags of the association.
    associatedResourceAccessibility String
    Accessibility of the resource.
    associatedResourceArn String
    ARN of the resource for this association.
    dnsEntries List<GetVpcEndpointAssociationsAssociationDnsEntry>
    DNS entries for the Association. DNS entry blocks are documented below.
    id String
    privateDnsEntries List<GetVpcEndpointAssociationsAssociationPrivateDnsEntry>
    DNS entries for the Association. Private DNS entry blocks are documented below.
    resourceConfigurationGroupArn String
    ARN of the Resource Group if the Resource is a member of a group.
    serviceNetworkArn String
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    serviceNetworkName String
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    tags Map<String,String>
    Tags of the association.
    associatedResourceAccessibility string
    Accessibility of the resource.
    associatedResourceArn string
    ARN of the resource for this association.
    dnsEntries GetVpcEndpointAssociationsAssociationDnsEntry[]
    DNS entries for the Association. DNS entry blocks are documented below.
    id string
    privateDnsEntries GetVpcEndpointAssociationsAssociationPrivateDnsEntry[]
    DNS entries for the Association. Private DNS entry blocks are documented below.
    resourceConfigurationGroupArn string
    ARN of the Resource Group if the Resource is a member of a group.
    serviceNetworkArn string
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    serviceNetworkName string
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    tags {[key: string]: string}
    Tags of the association.
    associated_resource_accessibility str
    Accessibility of the resource.
    associated_resource_arn str
    ARN of the resource for this association.
    dns_entries Sequence[GetVpcEndpointAssociationsAssociationDnsEntry]
    DNS entries for the Association. DNS entry blocks are documented below.
    id str
    private_dns_entries Sequence[GetVpcEndpointAssociationsAssociationPrivateDnsEntry]
    DNS entries for the Association. Private DNS entry blocks are documented below.
    resource_configuration_group_arn str
    ARN of the Resource Group if the Resource is a member of a group.
    service_network_arn str
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    service_network_name str
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    tags Mapping[str, str]
    Tags of the association.
    associatedResourceAccessibility String
    Accessibility of the resource.
    associatedResourceArn String
    ARN of the resource for this association.
    dnsEntries List<Property Map>
    DNS entries for the Association. DNS entry blocks are documented below.
    id String
    privateDnsEntries List<Property Map>
    DNS entries for the Association. Private DNS entry blocks are documented below.
    resourceConfigurationGroupArn String
    ARN of the Resource Group if the Resource is a member of a group.
    serviceNetworkArn String
    Service Network ARN. Applicable for endpoints of type ServiceNetwork.
    serviceNetworkName String
    Service Network Name. Applicable for endpoints of type ServiceNetwork.
    tags Map<String>
    Tags of the association.

    GetVpcEndpointAssociationsAssociationDnsEntry

    DnsName string
    DNS name.
    HostedZoneId string
    ID of the private hosted zone.
    DnsName string
    DNS name.
    HostedZoneId string
    ID of the private hosted zone.
    dnsName String
    DNS name.
    hostedZoneId String
    ID of the private hosted zone.
    dnsName string
    DNS name.
    hostedZoneId string
    ID of the private hosted zone.
    dns_name str
    DNS name.
    hosted_zone_id str
    ID of the private hosted zone.
    dnsName String
    DNS name.
    hostedZoneId String
    ID of the private hosted zone.

    GetVpcEndpointAssociationsAssociationPrivateDnsEntry

    DnsName string
    DNS name.
    HostedZoneId string
    ID of the private hosted zone.
    DnsName string
    DNS name.
    HostedZoneId string
    ID of the private hosted zone.
    dnsName String
    DNS name.
    hostedZoneId String
    ID of the private hosted zone.
    dnsName string
    DNS name.
    hostedZoneId string
    ID of the private hosted zone.
    dns_name str
    DNS name.
    hosted_zone_id str
    ID of the private hosted zone.
    dnsName String
    DNS name.
    hostedZoneId String
    ID of the private hosted zone.

    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
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi