github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/outposts/getOutpost.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package outposts

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides details about an Outposts Outpost.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func GetOutpost(ctx *pulumi.Context, args *GetOutpostArgs, opts ...pulumi.InvokeOption) (*GetOutpostResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv GetOutpostResult
	err := ctx.Invoke("aws:outposts/getOutpost:getOutpost", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getOutpost.
type GetOutpostArgs struct {
	// ARN.
	Arn *string `pulumi:"arn"`
	// Identifier of the Outpost.
	Id *string `pulumi:"id"`
	// Name of the Outpost.
	Name *string `pulumi:"name"`
	// AWS Account identifier of the Outpost owner.
	OwnerId *string `pulumi:"ownerId"`
	// The Outpost tags.
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getOutpost.
type GetOutpostResult struct {
	Arn string `pulumi:"arn"`
	// Availability Zone name.
	AvailabilityZone string `pulumi:"availabilityZone"`
	// Availability Zone identifier.
	AvailabilityZoneId string `pulumi:"availabilityZoneId"`
	// The description of the Outpost.
	Description string `pulumi:"description"`
	Id          string `pulumi:"id"`
	// The life cycle status.
	LifecycleStatus string  `pulumi:"lifecycleStatus"`
	Name            string  `pulumi:"name"`
	OwnerId         *string `pulumi:"ownerId"`
	// The Amazon Resource Name (ARN) of the site.
	SiteArn string `pulumi:"siteArn"`
	// The ID of the site.
	SiteId string `pulumi:"siteId"`
	// The hardware type.
	SupportedHardwareType string `pulumi:"supportedHardwareType"`
	// The Outpost tags.
	Tags map[string]string `pulumi:"tags"`
}

func GetOutpostOutput(ctx *pulumi.Context, args GetOutpostOutputArgs, opts ...pulumi.InvokeOption) GetOutpostResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetOutpostResult, error) {
			args := v.(GetOutpostArgs)
			r, err := GetOutpost(ctx, &args, opts...)
			var s GetOutpostResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetOutpostResultOutput)
}

// A collection of arguments for invoking getOutpost.
type GetOutpostOutputArgs struct {
	// ARN.
	Arn pulumi.StringPtrInput `pulumi:"arn"`
	// Identifier of the Outpost.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Name of the Outpost.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// AWS Account identifier of the Outpost owner.
	OwnerId pulumi.StringPtrInput `pulumi:"ownerId"`
	// The Outpost tags.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (GetOutpostOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*GetOutpostArgs)(nil)).Elem()
}

// A collection of values returned by getOutpost.
type GetOutpostResultOutput struct{ *pulumi.OutputState }

func (GetOutpostResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*GetOutpostResult)(nil)).Elem()
}

func (o GetOutpostResultOutput) ToGetOutpostResultOutput() GetOutpostResultOutput {
	return o
}

func (o GetOutpostResultOutput) ToGetOutpostResultOutputWithContext(ctx context.Context) GetOutpostResultOutput {
	return o
}

func (o GetOutpostResultOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.Arn }).(pulumi.StringOutput)
}

// Availability Zone name.
func (o GetOutpostResultOutput) AvailabilityZone() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.AvailabilityZone }).(pulumi.StringOutput)
}

// Availability Zone identifier.
func (o GetOutpostResultOutput) AvailabilityZoneId() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.AvailabilityZoneId }).(pulumi.StringOutput)
}

// The description of the Outpost.
func (o GetOutpostResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.Description }).(pulumi.StringOutput)
}

func (o GetOutpostResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.Id }).(pulumi.StringOutput)
}

// The life cycle status.
func (o GetOutpostResultOutput) LifecycleStatus() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.LifecycleStatus }).(pulumi.StringOutput)
}

func (o GetOutpostResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.Name }).(pulumi.StringOutput)
}

func (o GetOutpostResultOutput) OwnerId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetOutpostResult) *string { return v.OwnerId }).(pulumi.StringPtrOutput)
}

// The Amazon Resource Name (ARN) of the site.
func (o GetOutpostResultOutput) SiteArn() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.SiteArn }).(pulumi.StringOutput)
}

// The ID of the site.
func (o GetOutpostResultOutput) SiteId() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.SiteId }).(pulumi.StringOutput)
}

// The hardware type.
func (o GetOutpostResultOutput) SupportedHardwareType() pulumi.StringOutput {
	return o.ApplyT(func(v GetOutpostResult) string { return v.SupportedHardwareType }).(pulumi.StringOutput)
}

// The Outpost tags.
func (o GetOutpostResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v GetOutpostResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

func init() {
	pulumi.RegisterOutputType(GetOutpostResultOutput{})
}