aws.outposts.getOutpost

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.outposts.getOutpost({
    name: "example",
});

import pulumi
import pulumi_aws as aws

example = aws.outposts.get_outpost(name="example")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/outposts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outposts.GetOutpost(ctx, &outposts.GetOutpostArgs{
			Name: pulumi.StringRef("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.Outposts.GetOutpost.Invoke(new()
    {
        Name = "example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.outposts.OutpostsFunctions;
import com.pulumi.aws.outposts.inputs.GetOutpostArgs;
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 = OutpostsFunctions.getOutpost(GetOutpostArgs.builder()
            .name("example")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: aws:outposts:getOutpost
      Arguments:
        name: example

Using getOutpost

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 getOutpost(args: GetOutpostArgs, opts?: InvokeOptions): Promise<GetOutpostResult>
function getOutpostOutput(args: GetOutpostOutputArgs, opts?: InvokeOptions): Output<GetOutpostResult>

def get_outpost(arn: Optional[str] = None,
                id: Optional[str] = None,
                name: Optional[str] = None,
                owner_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetOutpostResult
def get_outpost_output(arn: Optional[pulumi.Input[str]] = None,
                id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                owner_id: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetOutpostResult]

func GetOutpost(ctx *Context, args *GetOutpostArgs, opts ...InvokeOption) (*GetOutpostResult, error)
func GetOutpostOutput(ctx *Context, args *GetOutpostOutputArgs, opts ...InvokeOption) GetOutpostResultOutput

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

public static class GetOutpost 
{
    public static Task<GetOutpostResult> InvokeAsync(GetOutpostArgs args, InvokeOptions? opts = null)
    public static Output<GetOutpostResult> Invoke(GetOutpostInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOutpostResult> getOutpost(GetOutpostArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:outposts/getOutpost:getOutpost
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: ARN.
Id string: Identifier of the Outpost.
Name string: Name of the Outpost.
OwnerId string: AWS Account identifier of the Outpost owner.
Tags Dictionary<string, string>: The Outpost tags.

Arn string: ARN.
Id string: Identifier of the Outpost.
Name string: Name of the Outpost.
OwnerId string: AWS Account identifier of the Outpost owner.
Tags map[string]string: The Outpost tags.

arn String: ARN.
id String: Identifier of the Outpost.
name String: Name of the Outpost.
ownerId String: AWS Account identifier of the Outpost owner.
tags Map<String,String>: The Outpost tags.

arn string: ARN.
id string: Identifier of the Outpost.
name string: Name of the Outpost.
ownerId string: AWS Account identifier of the Outpost owner.
tags {[key: string]: string}: The Outpost tags.

arn str: ARN.
id str: Identifier of the Outpost.
name str: Name of the Outpost.
owner_id str: AWS Account identifier of the Outpost owner.
tags Mapping[str, str]: The Outpost tags.

arn String: ARN.
id String: Identifier of the Outpost.
name String: Name of the Outpost.
ownerId String: AWS Account identifier of the Outpost owner.
tags Map<String>: The Outpost tags.

getOutpost Result

The following output properties are available:

Arn string
AvailabilityZone string: Availability Zone name.
AvailabilityZoneId string: Availability Zone identifier.
Description string: The description of the Outpost.
Id string
LifecycleStatus string: The life cycle status.
Name string
SiteArn string: The Amazon Resource Name (ARN) of the site.
SiteId string: The ID of the site.
SupportedHardwareType string: The hardware type.
Tags Dictionary<string, string>: The Outpost tags.
OwnerId string

Arn string
AvailabilityZone string: Availability Zone name.
AvailabilityZoneId string: Availability Zone identifier.
Description string: The description of the Outpost.
Id string
LifecycleStatus string: The life cycle status.
Name string
SiteArn string: The Amazon Resource Name (ARN) of the site.
SiteId string: The ID of the site.
SupportedHardwareType string: The hardware type.
Tags map[string]string: The Outpost tags.
OwnerId string

arn String
availabilityZone String: Availability Zone name.
availabilityZoneId String: Availability Zone identifier.
description String: The description of the Outpost.
id String
lifecycleStatus String: The life cycle status.
name String
siteArn String: The Amazon Resource Name (ARN) of the site.
siteId String: The ID of the site.
supportedHardwareType String: The hardware type.
tags Map<String,String>: The Outpost tags.
ownerId String

arn string
availabilityZone string: Availability Zone name.
availabilityZoneId string: Availability Zone identifier.
description string: The description of the Outpost.
id string
lifecycleStatus string: The life cycle status.
name string
siteArn string: The Amazon Resource Name (ARN) of the site.
siteId string: The ID of the site.
supportedHardwareType string: The hardware type.
tags {[key: string]: string}: The Outpost tags.
ownerId string

arn str
availability_zone str: Availability Zone name.
availability_zone_id str: Availability Zone identifier.
description str: The description of the Outpost.
id str
lifecycle_status str: The life cycle status.
name str
site_arn str: The Amazon Resource Name (ARN) of the site.
site_id str: The ID of the site.
supported_hardware_type str: The hardware type.
tags Mapping[str, str]: The Outpost tags.
owner_id str

arn String
availabilityZone String: Availability Zone name.
availabilityZoneId String: Availability Zone identifier.
description String: The description of the Outpost.
id String
lifecycleStatus String: The life cycle status.
name String
siteArn String: The Amazon Resource Name (ARN) of the site.
siteId String: The ID of the site.
supportedHardwareType String: The hardware type.
tags Map<String>: The Outpost tags.
ownerId String

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.outposts.getOutpost

On this page

On this page

Example Usage

Using getOutpost

getOutpost Result

Package Details

On this page

On this page