@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
240 lines (239 loc) • 8.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Transfer Family Web App.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const current = aws.getCallerIdentity({});
* const currentGetRegion = aws.getRegion({});
* const currentGetPartition = aws.getPartition({});
* const example = aws.ssoadmin.getInstances({});
* const assumeRoleTransfer = current.then(current => aws.iam.getPolicyDocument({
* statements: [{
* effect: "Allow",
* actions: [
* "sts:AssumeRole",
* "sts:SetContext",
* ],
* principals: [{
* type: "Service",
* identifiers: ["transfer.amazonaws.com"],
* }],
* conditions: [{
* test: "StringEquals",
* values: [current.accountId],
* variable: "aws:SourceAccount",
* }],
* }],
* }));
* const exampleRole = new aws.iam.Role("example", {
* name: "example",
* assumeRolePolicy: assumeRoleTransfer.then(assumeRoleTransfer => assumeRoleTransfer.json),
* });
* const exampleGetPolicyDocument = Promise.all([currentGetPartition, currentGetRegion, current, current, current]).then(([currentGetPartition, currentGetRegion, current, current1, current2]) => aws.iam.getPolicyDocument({
* statements: [
* {
* effect: "Allow",
* actions: [
* "s3:GetDataAccess",
* "s3:ListCallerAccessGrants",
* ],
* resources: [`arn:${currentGetPartition.partition}:s3:${currentGetRegion.name}:${current.accountId}:access-grants/*`],
* conditions: [{
* test: "StringEquals",
* values: [current1.accountId],
* variable: "s3:ResourceAccount",
* }],
* },
* {
* effect: "Allow",
* actions: ["s3:ListAccessGrantsInstances"],
* resources: ["*"],
* conditions: [{
* test: "StringEquals",
* values: [current2.accountId],
* variable: "s3:ResourceAccount",
* }],
* },
* ],
* }));
* const exampleRolePolicy = new aws.iam.RolePolicy("example", {
* policy: exampleGetPolicyDocument.then(exampleGetPolicyDocument => exampleGetPolicyDocument.json),
* role: exampleRole.name,
* });
* const exampleWebApp = new aws.transfer.WebApp("example", {
* identityProviderDetails: {
* identityCenterConfig: {
* instanceArn: example.then(example => example.arns?.[0]),
* role: exampleRole.arn,
* },
* },
* webAppUnits: [{
* provisioned: 1,
* }],
* tags: {
* Name: "test",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Transfer Family Web App using the `web_app_id`. For example:
*
* ```sh
* $ pulumi import aws:transfer/webApp:WebApp example web_app-id-12345678
* ```
*/
export declare class WebApp extends pulumi.CustomResource {
/**
* Get an existing WebApp 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?: WebAppState, opts?: pulumi.CustomResourceOptions): WebApp;
/**
* Returns true if the given object is an instance of WebApp. 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 WebApp;
/**
* URL provided to interact with the Transfer Family web app.
*/
readonly accessEndpoint: pulumi.Output<string>;
/**
* ARN of the Web App.
*/
readonly arn: pulumi.Output<string>;
/**
* Block for details of the identity provider to use with the web app. See Identity provider details below.
*
* The following arguments are optional:
*/
readonly identityProviderDetails: pulumi.Output<outputs.transfer.WebAppIdentityProviderDetails | undefined>;
/**
* 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>;
/**
* Key-value pairs that can be used to group and search for web apps.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Type of endpoint policy for the web app. Valid values are: `STANDARD`(default) or `FIPS`.
*/
readonly webAppEndpointPolicy: pulumi.Output<string>;
/**
* ID of the Wep App resource.
*/
readonly webAppId: pulumi.Output<string>;
/**
* Block for number of concurrent connections or the user sessions on the web app.
* * provisioned - (Optional) Number of units of concurrent connections.
*/
readonly webAppUnits: pulumi.Output<outputs.transfer.WebAppWebAppUnit[]>;
/**
* Create a WebApp 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?: WebAppArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering WebApp resources.
*/
export interface WebAppState {
/**
* URL provided to interact with the Transfer Family web app.
*/
accessEndpoint?: pulumi.Input<string>;
/**
* ARN of the Web App.
*/
arn?: pulumi.Input<string>;
/**
* Block for details of the identity provider to use with the web app. See Identity provider details below.
*
* The following arguments are optional:
*/
identityProviderDetails?: pulumi.Input<inputs.transfer.WebAppIdentityProviderDetails>;
/**
* 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>;
/**
* Key-value pairs that can be used to group and search for web apps.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Type of endpoint policy for the web app. Valid values are: `STANDARD`(default) or `FIPS`.
*/
webAppEndpointPolicy?: pulumi.Input<string>;
/**
* ID of the Wep App resource.
*/
webAppId?: pulumi.Input<string>;
/**
* Block for number of concurrent connections or the user sessions on the web app.
* * provisioned - (Optional) Number of units of concurrent connections.
*/
webAppUnits?: pulumi.Input<pulumi.Input<inputs.transfer.WebAppWebAppUnit>[]>;
}
/**
* The set of arguments for constructing a WebApp resource.
*/
export interface WebAppArgs {
/**
* URL provided to interact with the Transfer Family web app.
*/
accessEndpoint?: pulumi.Input<string>;
/**
* Block for details of the identity provider to use with the web app. See Identity provider details below.
*
* The following arguments are optional:
*/
identityProviderDetails?: pulumi.Input<inputs.transfer.WebAppIdentityProviderDetails>;
/**
* 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>;
/**
* Key-value pairs that can be used to group and search for web apps.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Type of endpoint policy for the web app. Valid values are: `STANDARD`(default) or `FIPS`.
*/
webAppEndpointPolicy?: pulumi.Input<string>;
/**
* Block for number of concurrent connections or the user sessions on the web app.
* * provisioned - (Optional) Number of units of concurrent connections.
*/
webAppUnits?: pulumi.Input<pulumi.Input<inputs.transfer.WebAppWebAppUnit>[]>;
}