@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
140 lines (139 loc) • 4.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages a Network Manager site. Use this resource to create a site in a global network.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.networkmanager.GlobalNetwork("example", {});
* const exampleSite = new aws.networkmanager.Site("example", {globalNetworkId: example.id});
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_networkmanager_site` using the site ARN. For example:
*
* ```sh
* $ pulumi import aws:networkmanager/site:Site example arn:aws:networkmanager::123456789012:site/global-network-0d47f6t230mz46dy4/site-444555aaabbb11223
* ```
*/
export declare class Site extends pulumi.CustomResource {
/**
* Get an existing Site resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SiteState, opts?: pulumi.CustomResourceOptions): Site;
/**
* Returns true if the given object is an instance of Site. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Site;
/**
* Site ARN.
*/
readonly arn: pulumi.Output<string>;
/**
* Description of the Site.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* ID of the Global Network to create the site in.
*
* The following arguments are optional:
*/
readonly globalNetworkId: pulumi.Output<string>;
/**
* Site location. See below.
*/
readonly location: pulumi.Output<outputs.networkmanager.SiteLocation | undefined>;
/**
* Key-value tags for the Site. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Site resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SiteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Site resources.
*/
export interface SiteState {
/**
* Site ARN.
*/
arn?: pulumi.Input<string>;
/**
* Description of the Site.
*/
description?: pulumi.Input<string>;
/**
* ID of the Global Network to create the site in.
*
* The following arguments are optional:
*/
globalNetworkId?: pulumi.Input<string>;
/**
* Site location. See below.
*/
location?: pulumi.Input<inputs.networkmanager.SiteLocation>;
/**
* Key-value tags for the Site. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Site resource.
*/
export interface SiteArgs {
/**
* Description of the Site.
*/
description?: pulumi.Input<string>;
/**
* ID of the Global Network to create the site in.
*
* The following arguments are optional:
*/
globalNetworkId: pulumi.Input<string>;
/**
* Site location. See below.
*/
location?: pulumi.Input<inputs.networkmanager.SiteLocation>;
/**
* Key-value tags for the Site. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}