AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.directconnect.getGateway
Explore with Pulumi AI
Retrieve information about a Direct Connect Gateway.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.directconnect.getGateway({
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.directconnect.get_gateway(name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directconnect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := directconnect.LookupGateway(ctx, &directconnect.LookupGatewayArgs{
Name: "example",
}, 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.DirectConnect.GetGateway.Invoke(new()
{
Name = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.DirectconnectFunctions;
import com.pulumi.aws.directconnect.inputs.GetGatewayArgs;
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 = DirectconnectFunctions.getGateway(GetGatewayArgs.builder()
.name("example")
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:directconnect:getGateway
Arguments:
name: example
Using getGateway
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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
def get_gateway(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
> Note: This function is named LookupGateway
in the Go SDK.
public static class GetGateway
{
public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:directconnect/getGateway:getGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of the gateway to retrieve.
- Name string
- Name of the gateway to retrieve.
- name String
- Name of the gateway to retrieve.
- name string
- Name of the gateway to retrieve.
- name str
- Name of the gateway to retrieve.
- name String
- Name of the gateway to retrieve.
getGateway Result
The following output properties are available:
- Amazon
Side stringAsn - ASN on the Amazon side of the connection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Owner
Account stringId - AWS Account ID of the gateway.
- Amazon
Side stringAsn - ASN on the Amazon side of the connection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Owner
Account stringId - AWS Account ID of the gateway.
- amazon
Side StringAsn - ASN on the Amazon side of the connection.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- owner
Account StringId - AWS Account ID of the gateway.
- amazon
Side stringAsn - ASN on the Amazon side of the connection.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- owner
Account stringId - AWS Account ID of the gateway.
- amazon_
side_ strasn - ASN on the Amazon side of the connection.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- owner_
account_ strid - AWS Account ID of the gateway.
- amazon
Side StringAsn - ASN on the Amazon side of the connection.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- owner
Account StringId - AWS Account ID of the gateway.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.