1. Packages
  2. Yandex
  3. API Docs
  4. getVpcAddress
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

yandex.getVpcAddress

Explore with Pulumi AI

yandex logo
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

    Get information about a Yandex VPC address. For more information, see Yandex.Cloud VPC.

    import * as pulumi from "@pulumi/pulumi";
    import * as yandex from "@pulumi/yandex";
    
    const addr = pulumi.output(yandex.getVpcAddress({
        addressId: "my-address-id",
    }));
    
    import pulumi
    import pulumi_yandex as yandex
    
    addr = yandex.get_vpc_address(address_id="my-address-id")
    
    using Pulumi;
    using Yandex = Pulumi.Yandex;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var addr = Output.Create(Yandex.GetVpcAddress.InvokeAsync(new Yandex.GetVpcAddressArgs
            {
                AddressId = "my-address-id",
            }));
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		opt0 := "my-address-id"
    		_, err := yandex.LookupVpcAddress(ctx, &GetVpcAddressArgs{
    			AddressId: &opt0,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    This data source is used to define [VPC Address] that can be used by other resources.

    Using getVpcAddress

    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 getVpcAddress(args: GetVpcAddressArgs, opts?: InvokeOptions): Promise<GetVpcAddressResult>
    function getVpcAddressOutput(args: GetVpcAddressOutputArgs, opts?: InvokeOptions): Output<GetVpcAddressResult>
    def get_vpc_address(address_id: Optional[str] = None,
                        folder_id: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVpcAddressResult
    def get_vpc_address_output(address_id: Optional[pulumi.Input[str]] = None,
                        folder_id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVpcAddressResult]
    func LookupVpcAddress(ctx *Context, args *LookupVpcAddressArgs, opts ...InvokeOption) (*LookupVpcAddressResult, error)
    func LookupVpcAddressOutput(ctx *Context, args *LookupVpcAddressOutputArgs, opts ...InvokeOption) LookupVpcAddressResultOutput

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

    public static class GetVpcAddress 
    {
        public static Task<GetVpcAddressResult> InvokeAsync(GetVpcAddressArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcAddressResult> Invoke(GetVpcAddressInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcAddressResult> getVpcAddress(GetVpcAddressArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: yandex:index/getVpcAddress:getVpcAddress
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AddressId string
    ID of the address.
    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    Name string
    Name of the address.
    AddressId string
    ID of the address.
    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    Name string
    Name of the address.
    addressId String
    ID of the address.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name String
    Name of the address.
    addressId string
    ID of the address.
    folderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name string
    Name of the address.
    address_id str
    ID of the address.
    folder_id str
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name str
    Name of the address.
    addressId String
    ID of the address.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    name String
    Name of the address.

    getVpcAddress Result

    The following output properties are available:

    AddressId string
    CreatedAt string
    Creation timestamp of this address.
    Description string
    Description of the address.
    ExternalIpv4Addresses List<GetVpcAddressExternalIpv4Address>
    spec of IP v4 address.
    FolderId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, string>
    Labels assigned to this address.
    Name string
    Reserved bool
    false means that address is ephemeral.
    Used bool
    true if address is used.
    AddressId string
    CreatedAt string
    Creation timestamp of this address.
    Description string
    Description of the address.
    ExternalIpv4Addresses []GetVpcAddressExternalIpv4Address
    spec of IP v4 address.
    FolderId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]string
    Labels assigned to this address.
    Name string
    Reserved bool
    false means that address is ephemeral.
    Used bool
    true if address is used.
    addressId String
    createdAt String
    Creation timestamp of this address.
    description String
    Description of the address.
    externalIpv4Addresses List<GetVpcAddressExternalIpv4Address>
    spec of IP v4 address.
    folderId String
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,String>
    Labels assigned to this address.
    name String
    reserved Boolean
    false means that address is ephemeral.
    used Boolean
    true if address is used.
    addressId string
    createdAt string
    Creation timestamp of this address.
    description string
    Description of the address.
    externalIpv4Addresses GetVpcAddressExternalIpv4Address[]
    spec of IP v4 address.
    folderId string
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: string}
    Labels assigned to this address.
    name string
    reserved boolean
    false means that address is ephemeral.
    used boolean
    true if address is used.
    address_id str
    created_at str
    Creation timestamp of this address.
    description str
    Description of the address.
    external_ipv4_addresses Sequence[GetVpcAddressExternalIpv4Address]
    spec of IP v4 address.
    folder_id str
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, str]
    Labels assigned to this address.
    name str
    reserved bool
    false means that address is ephemeral.
    used bool
    true if address is used.
    addressId String
    createdAt String
    Creation timestamp of this address.
    description String
    Description of the address.
    externalIpv4Addresses List<Property Map>
    spec of IP v4 address.
    folderId String
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String>
    Labels assigned to this address.
    name String
    reserved Boolean
    false means that address is ephemeral.
    used Boolean
    true if address is used.

    Supporting Types

    GetVpcAddressExternalIpv4Address

    Address string
    IP address.
    DdosProtectionProvider string
    DDOS protection provider.
    OutgoingSmtpCapability string
    Outgoing smtp capability.
    ZoneId string
    Zone for allocating address.
    Address string
    IP address.
    DdosProtectionProvider string
    DDOS protection provider.
    OutgoingSmtpCapability string
    Outgoing smtp capability.
    ZoneId string
    Zone for allocating address.
    address String
    IP address.
    ddosProtectionProvider String
    DDOS protection provider.
    outgoingSmtpCapability String
    Outgoing smtp capability.
    zoneId String
    Zone for allocating address.
    address string
    IP address.
    ddosProtectionProvider string
    DDOS protection provider.
    outgoingSmtpCapability string
    Outgoing smtp capability.
    zoneId string
    Zone for allocating address.
    address str
    IP address.
    ddos_protection_provider str
    DDOS protection provider.
    outgoing_smtp_capability str
    Outgoing smtp capability.
    zone_id str
    Zone for allocating address.
    address String
    IP address.
    ddosProtectionProvider String
    DDOS protection provider.
    outgoingSmtpCapability String
    Outgoing smtp capability.
    zoneId String
    Zone for allocating address.

    Package Details

    Repository
    Yandex pulumi/pulumi-yandex
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the yandex Terraform Provider.
    yandex logo
    Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi