AWS v6.55.0 published on Monday, Oct 7, 2024 by Pulumi
aws.networkmanager.getSite
Explore with Pulumi AI
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,
});
import pulumi
import pulumi_aws as aws
example = aws.networkmanager.get_site(global_network_id=global_network_id,
site_id=site_id)
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
})
}
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,
});
});
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());
}
}
variables:
example:
fn::invoke:
Function: aws:networkmanager:getSite
Arguments:
globalNetworkId: ${globalNetworkId}
siteId: ${siteId}
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>
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]
func LookupSite(ctx *Context, args *LookupSiteArgs, opts ...InvokeOption) (*LookupSiteResult, error)
func LookupSiteOutput(ctx *Context, args *LookupSiteOutputArgs, opts ...InvokeOption) LookupSiteResultOutput
> 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)
}
public static CompletableFuture<GetSiteResult> getSite(GetSiteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:networkmanager/getSite:getSite
arguments:
# arguments dictionary
The following arguments are supported:
- Global
Network stringId - ID of the Global Network of the site to retrieve.
- Site
Id string - ID of the specific site to retrieve.
- Dictionary<string, string>
- Key-value tags for the Site.
- Global
Network stringId - ID of the Global Network of the site to retrieve.
- Site
Id string - ID of the specific site to retrieve.
- map[string]string
- Key-value tags for the Site.
- global
Network StringId - ID of the Global Network of the site to retrieve.
- site
Id String - ID of the specific site to retrieve.
- Map<String,String>
- Key-value tags for the Site.
- global
Network stringId - ID of the Global Network of the site to retrieve.
- site
Id string - ID of the specific site to retrieve.
- {[key: string]: string}
- Key-value tags for the Site.
- global_
network_ strid - ID of the Global Network of the site to retrieve.
- site_
id str - ID of the specific site to retrieve.
- Mapping[str, str]
- Key-value tags for the Site.
- global
Network StringId - ID of the Global Network of the site to retrieve.
- site
Id String - ID of the specific site to retrieve.
- 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.
- Global
Network stringId - Id string
- The provider-assigned unique ID for this managed resource.
- Locations
List<Get
Site Location> - Site location as documented below.
- Site
Id string - Dictionary<string, string>
- Key-value tags for the Site.
- Arn string
- ARN of the site.
- Description string
- Description of the site.
- Global
Network stringId - Id string
- The provider-assigned unique ID for this managed resource.
- Locations
[]Get
Site Location - Site location as documented below.
- Site
Id string - map[string]string
- Key-value tags for the Site.
- arn String
- ARN of the site.
- description String
- Description of the site.
- global
Network StringId - id String
- The provider-assigned unique ID for this managed resource.
- locations
List<Get
Site Location> - Site location as documented below.
- site
Id String - Map<String,String>
- Key-value tags for the Site.
- arn string
- ARN of the site.
- description string
- Description of the site.
- global
Network stringId - id string
- The provider-assigned unique ID for this managed resource.
- locations
Get
Site Location[] - Site location as documented below.
- site
Id string - {[key: string]: string}
- Key-value tags for the Site.
- arn str
- ARN of the site.
- description str
- Description of the site.
- global_
network_ strid - id str
- The provider-assigned unique ID for this managed resource.
- locations
Sequence[Get
Site Location] - Site location as documented below.
- site_
id str - Mapping[str, str]
- Key-value tags for the Site.
- arn String
- ARN of the site.
- description String
- Description of the site.
- global
Network StringId - id String
- The provider-assigned unique ID for this managed resource.
- locations List<Property Map>
- Site location as documented below.
- site
Id String - Map<String>
- Key-value tags for the Site.
Supporting Types
GetSiteLocation
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.