1. Packages
  2. AWS
  3. API Docs
  4. outposts
  5. getSite
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.outposts.getSite

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Provides details about an Outposts Site.

Example Usage

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

const example = aws.outposts.getSite({
    name: "example",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.outposts.get_site(name="example")
Copy
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.GetSite(ctx, &outposts.GetSiteArgs{
			Name: pulumi.StringRef("example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Outposts.GetSite.Invoke(new()
    {
        Name = "example",
    });

});
Copy
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.GetSiteArgs;
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.getSite(GetSiteArgs.builder()
            .name("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:outposts:getSite
      arguments:
        name: example
Copy

Using getSite

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 getSite(args: GetSiteArgs, opts?: InvokeOptions): Promise<GetSiteResult>
function getSiteOutput(args: GetSiteOutputArgs, opts?: InvokeOptions): Output<GetSiteResult>
Copy
def get_site(id: Optional[str] = None,
             name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetSiteResult
def get_site_output(id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetSiteResult]
Copy
func GetSite(ctx *Context, args *GetSiteArgs, opts ...InvokeOption) (*GetSiteResult, error)
func GetSiteOutput(ctx *Context, args *GetSiteOutputArgs, opts ...InvokeOption) GetSiteResultOutput
Copy

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

public static class GetSite 
{
    public static Task<GetSiteResult> InvokeAsync(GetSiteArgs args, InvokeOptions? opts = null)
    public static Output<GetSiteResult> Invoke(GetSiteInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSiteResult> getSite(GetSiteArgs args, InvokeOptions options)
public static Output<GetSiteResult> getSite(GetSiteArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:outposts/getSite:getSite
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Identifier of the Site.
Name string
Name of the Site.
Id string
Identifier of the Site.
Name string
Name of the Site.
id String
Identifier of the Site.
name String
Name of the Site.
id string
Identifier of the Site.
name string
Name of the Site.
id str
Identifier of the Site.
name str
Name of the Site.
id String
Identifier of the Site.
name String
Name of the Site.

getSite Result

The following output properties are available:

AccountId string
AWS Account identifier.
Description string
Description.
Id string
Name string
AccountId string
AWS Account identifier.
Description string
Description.
Id string
Name string
accountId String
AWS Account identifier.
description String
Description.
id String
name String
accountId string
AWS Account identifier.
description string
Description.
id string
name string
account_id str
AWS Account identifier.
description str
Description.
id str
name str
accountId String
AWS Account identifier.
description String
Description.
id String
name 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.77.0 published on Wednesday, Apr 9, 2025 by Pulumi