Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. getSite
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.networkmanager.getSite

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Retrieve information about a site.

Example Usage

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

const example = aws.networkmanager.getSite({
    globalNetworkId: globalNetworkId,
    siteId: siteId,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.get_site(global_network_id=global_network_id,
    site_id=site_id)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmanager.LookupSite(ctx, &networkmanager.LookupSiteArgs{
			GlobalNetworkId: globalNetworkId,
			SiteId:          siteId,
		}, 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.NetworkManager.GetSite.Invoke(new()
    {
        GlobalNetworkId = globalNetworkId,
        SiteId = siteId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.NetworkmanagerFunctions;
import com.pulumi.aws.networkmanager.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 = NetworkmanagerFunctions.getSite(GetSiteArgs.builder()
            .globalNetworkId(globalNetworkId)
            .siteId(siteId)
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:networkmanager:getSite
      arguments:
        globalNetworkId: ${globalNetworkId}
        siteId: ${siteId}
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(global_network_id: Optional[str] = None,
             site_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             opts: Optional[InvokeOptions] = None) -> GetSiteResult
def get_site_output(global_network_id: Optional[pulumi.Input[str]] = None,
             site_id: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetSiteResult]
Copy
func LookupSite(ctx *Context, args *LookupSiteArgs, opts ...InvokeOption) (*LookupSiteResult, error)
func LookupSiteOutput(ctx *Context, args *LookupSiteOutputArgs, opts ...InvokeOption) LookupSiteResultOutput
Copy

> Note: This function is named LookupSite 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:networkmanager/getSite:getSite
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GlobalNetworkId This property is required. string
ID of the Global Network of the site to retrieve.
SiteId This property is required. string
ID of the specific site to retrieve.
Tags Dictionary<string, string>
Key-value tags for the Site.
GlobalNetworkId This property is required. string
ID of the Global Network of the site to retrieve.
SiteId This property is required. string
ID of the specific site to retrieve.
Tags map[string]string
Key-value tags for the Site.
globalNetworkId This property is required. String
ID of the Global Network of the site to retrieve.
siteId This property is required. String
ID of the specific site to retrieve.
tags Map<String,String>
Key-value tags for the Site.
globalNetworkId This property is required. string
ID of the Global Network of the site to retrieve.
siteId This property is required. string
ID of the specific site to retrieve.
tags {[key: string]: string}
Key-value tags for the Site.
global_network_id This property is required. str
ID of the Global Network of the site to retrieve.
site_id This property is required. str
ID of the specific site to retrieve.
tags Mapping[str, str]
Key-value tags for the Site.
globalNetworkId This property is required. String
ID of the Global Network of the site to retrieve.
siteId This property is required. String
ID of the specific site to retrieve.
tags Map<String>
Key-value tags for the Site.

getSite Result

The following output properties are available:

Arn string
ARN of the site.
Description string
Description of the site.
GlobalNetworkId string
Id string
The provider-assigned unique ID for this managed resource.
Locations List<GetSiteLocation>
Site location as documented below.
SiteId string
Tags Dictionary<string, string>
Key-value tags for the Site.
Arn string
ARN of the site.
Description string
Description of the site.
GlobalNetworkId string
Id string
The provider-assigned unique ID for this managed resource.
Locations []GetSiteLocation
Site location as documented below.
SiteId string
Tags map[string]string
Key-value tags for the Site.
arn String
ARN of the site.
description String
Description of the site.
globalNetworkId String
id String
The provider-assigned unique ID for this managed resource.
locations List<GetSiteLocation>
Site location as documented below.
siteId String
tags Map<String,String>
Key-value tags for the Site.
arn string
ARN of the site.
description string
Description of the site.
globalNetworkId string
id string
The provider-assigned unique ID for this managed resource.
locations GetSiteLocation[]
Site location as documented below.
siteId string
tags {[key: string]: string}
Key-value tags for the Site.
arn str
ARN of the site.
description str
Description of the site.
global_network_id str
id str
The provider-assigned unique ID for this managed resource.
locations Sequence[GetSiteLocation]
Site location as documented below.
site_id str
tags Mapping[str, str]
Key-value tags for the Site.
arn String
ARN of the site.
description String
Description of the site.
globalNetworkId String
id String
The provider-assigned unique ID for this managed resource.
locations List<Property Map>
Site location as documented below.
siteId String
tags Map<String>
Key-value tags for the Site.

Supporting Types

GetSiteLocation

Address This property is required. string
Address of the location.
Latitude This property is required. string
Latitude of the location.
Longitude This property is required. string
Longitude of the location.
Address This property is required. string
Address of the location.
Latitude This property is required. string
Latitude of the location.
Longitude This property is required. string
Longitude of the location.
address This property is required. String
Address of the location.
latitude This property is required. String
Latitude of the location.
longitude This property is required. String
Longitude of the location.
address This property is required. string
Address of the location.
latitude This property is required. string
Latitude of the location.
longitude This property is required. string
Longitude of the location.
address This property is required. str
Address of the location.
latitude This property is required. str
Latitude of the location.
longitude This property is required. str
Longitude of the location.
address This property is required. String
Address of the location.
latitude This property is required. String
Latitude of the location.
longitude This property is required. String
Longitude of the location.

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
pulumi/pulumi-aws