@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
103 lines (102 loc) • 4.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for managing an AWS WorkSpaces Web IP Access Settings Association.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.workspacesweb.Portal("example", {displayName: "example"});
* const exampleIpAccessSettings = new aws.workspacesweb.IpAccessSettings("example", {
* displayName: "example",
* ipRules: [{
* ipRange: "10.0.0.0/16",
* }],
* });
* const exampleIpAccessSettingsAssociation = new aws.workspacesweb.IpAccessSettingsAssociation("example", {
* ipAccessSettingsArn: exampleIpAccessSettings.ipAccessSettingsArn,
* portalArn: example.portalArn,
* });
* ```
*/
export declare class IpAccessSettingsAssociation extends pulumi.CustomResource {
/**
* Get an existing IpAccessSettingsAssociation 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?: IpAccessSettingsAssociationState, opts?: pulumi.CustomResourceOptions): IpAccessSettingsAssociation;
/**
* Returns true if the given object is an instance of IpAccessSettingsAssociation. 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 IpAccessSettingsAssociation;
/**
* ARN of the IP access settings to associate with the portal. Forces replacement if changed.
*/
readonly ipAccessSettingsArn: pulumi.Output<string>;
/**
* ARN of the portal to associate with the IP access settings. Forces replacement if changed.
*
* The following arguments are optional:
*/
readonly portalArn: 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>;
/**
* Create a IpAccessSettingsAssociation 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: IpAccessSettingsAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IpAccessSettingsAssociation resources.
*/
export interface IpAccessSettingsAssociationState {
/**
* ARN of the IP access settings to associate with the portal. Forces replacement if changed.
*/
ipAccessSettingsArn?: pulumi.Input<string>;
/**
* ARN of the portal to associate with the IP access settings. Forces replacement if changed.
*
* The following arguments are optional:
*/
portalArn?: 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>;
}
/**
* The set of arguments for constructing a IpAccessSettingsAssociation resource.
*/
export interface IpAccessSettingsAssociationArgs {
/**
* ARN of the IP access settings to associate with the portal. Forces replacement if changed.
*/
ipAccessSettingsArn: pulumi.Input<string>;
/**
* ARN of the portal to associate with the IP access settings. Forces replacement if changed.
*
* The following arguments are optional:
*/
portalArn: 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>;
}