@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
190 lines (189 loc) • 7.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for managing an AWS WorkSpaces Web Network Settings resource. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as std from "@pulumi/std";
*
* const example = new aws.ec2.Vpc("example", {cidrBlock: "10.0.0.0/16"});
* const exampleSubnet: aws.ec2.Subnet[] = [];
* for (const range = {value: 0}; range.value < 2; range.value++) {
* exampleSubnet.push(new aws.ec2.Subnet(`example-${range.value}`, {
* vpcId: example.id,
* cidrBlock: example.cidrBlock.apply(cidrBlock => std.cidrsubnetOutput({
* input: cidrBlock,
* newbits: 8,
* netnum: range.value,
* })).apply(invoke => invoke.result),
* availabilityZone: available.names[range.value],
* }));
* }
* const example1: aws.ec2.SecurityGroup[] = [];
* for (const range = {value: 0}; range.value < 2; range.value++) {
* example1.push(new aws.ec2.SecurityGroup(`example1-${range.value}`, {
* vpcId: example.id,
* name: `example-sg-${range.value}$`,
* }));
* }
* const exampleNetworkSettings = new aws.workspacesweb.NetworkSettings("example", {
* vpcId: example.id,
* subnetIds: [
* exampleSubnet[0].id,
* exampleSubnet[1].id,
* ],
* securityGroupIds: [
* exampleAwsSecurityGroup[0].id,
* exampleAwsSecurityGroup[1].id,
* ],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import WorkSpaces Web Network Settings using the `network_settings_arn`. For example:
*
* ```sh
* $ pulumi import aws:workspacesweb/networkSettings:NetworkSettings example arn:aws:workspacesweb:us-west-2:123456789012:networksettings/abcdef12345
* ```
*/
export declare class NetworkSettings extends pulumi.CustomResource {
/**
* Get an existing NetworkSettings 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?: NetworkSettingsState, opts?: pulumi.CustomResourceOptions): NetworkSettings;
/**
* Returns true if the given object is an instance of NetworkSettings. 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 NetworkSettings;
/**
* List of web portal ARNs associated with the network settings.
*/
readonly associatedPortalArns: pulumi.Output<string[]>;
/**
* ARN of the network settings resource.
*/
readonly networkSettingsArn: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* One or more security groups used to control access from streaming instances to your VPC.
*/
readonly securityGroupIds: pulumi.Output<string[]>;
/**
* The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two subnet ids must be specified.
*/
readonly subnetIds: pulumi.Output<string[]>;
/**
* Map of tags assigned to the resource. 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;
}>;
/**
* The VPC that streaming instances will connect to.
*
* The following arguments are optional:
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a NetworkSettings 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: NetworkSettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetworkSettings resources.
*/
export interface NetworkSettingsState {
/**
* List of web portal ARNs associated with the network settings.
*/
associatedPortalArns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* ARN of the network settings resource.
*/
networkSettingsArn?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* One or more security groups used to control access from streaming instances to your VPC.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two subnet ids must be specified.
*/
subnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Map of tags assigned to the resource. 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 VPC that streaming instances will connect to.
*
* The following arguments are optional:
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetworkSettings resource.
*/
export interface NetworkSettingsArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* One or more security groups used to control access from streaming instances to your VPC.
*/
securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two subnet ids must be specified.
*/
subnetIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* Map of tags assigned to the resource. 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>;
}>;
/**
* The VPC that streaming instances will connect to.
*
* The following arguments are optional:
*/
vpcId: pulumi.Input<string>;
}