aws.transfer.WebApp
Resource for managing an AWS Transfer Family Web App.
Example Usage
Basic Usage
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 pulumi
import pulumi_aws as aws
current = aws.get_caller_identity()
current_get_region = aws.get_region()
current_get_partition = aws.get_partition()
example = aws.ssoadmin.get_instances()
assume_role_transfer = aws.iam.get_policy_document(statements=[{
"effect": "Allow",
"actions": [
"sts:AssumeRole",
"sts:SetContext",
],
"principals": [{
"type": "Service",
"identifiers": ["transfer.amazonaws.com"],
}],
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "aws:SourceAccount",
}],
}])
example_role = aws.iam.Role("example",
name="example",
assume_role_policy=assume_role_transfer.json)
example_get_policy_document = aws.iam.get_policy_document(statements=[
{
"effect": "Allow",
"actions": [
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
],
"resources": [f"arn:{current_get_partition.partition}:s3:{current_get_region.name}:{current.account_id}:access-grants/*"],
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "s3:ResourceAccount",
}],
},
{
"effect": "Allow",
"actions": ["s3:ListAccessGrantsInstances"],
"resources": ["*"],
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "s3:ResourceAccount",
}],
},
])
example_role_policy = aws.iam.RolePolicy("example",
policy=example_get_policy_document.json,
role=example_role.name)
example_web_app = aws.transfer.WebApp("example",
identity_provider_details={
"identity_center_config": {
"instance_arn": example.arns[0],
"role": example_role.arn,
},
},
web_app_units=[{
"provisioned": 1,
}],
tags={
"Name": "test",
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssoadmin"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{
}, nil);
if err != nil {
return err
}
currentGetRegion, err := aws.GetRegion(ctx, &aws.GetRegionArgs{
}, nil);
if err != nil {
return err
}
currentGetPartition, err := aws.GetPartition(ctx, &aws.GetPartitionArgs{
}, nil);
if err != nil {
return err
}
example, err := ssoadmin.GetInstances(ctx, &ssoadmin.GetInstancesArgs{
}, nil);
if err != nil {
return err
}
assumeRoleTransfer, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"sts:AssumeRole",
"sts:SetContext",
},
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "Service",
Identifiers: []string{
"transfer.amazonaws.com",
},
},
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: interface{}{
current.AccountId,
},
Variable: "aws:SourceAccount",
},
},
},
},
}, nil);
if err != nil {
return err
}
exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
Name: pulumi.String("example"),
AssumeRolePolicy: pulumi.String(assumeRoleTransfer.Json),
})
if err != nil {
return err
}
exampleGetPolicyDocument, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
},
Resources: []string{
fmt.Sprintf("arn:%v:s3:%v:%v:access-grants/*", currentGetPartition.Partition, currentGetRegion.Name, current.AccountId),
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: interface{}{
current.AccountId,
},
Variable: "s3:ResourceAccount",
},
},
},
{
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"s3:ListAccessGrantsInstances",
},
Resources: []string{
"*",
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: interface{}{
current.AccountId,
},
Variable: "s3:ResourceAccount",
},
},
},
},
}, nil);
if err != nil {
return err
}
_, err = iam.NewRolePolicy(ctx, "example", &iam.RolePolicyArgs{
Policy: pulumi.String(exampleGetPolicyDocument.Json),
Role: exampleRole.Name,
})
if err != nil {
return err
}
_, err = transfer.NewWebApp(ctx, "example", &transfer.WebAppArgs{
IdentityProviderDetails: &transfer.WebAppIdentityProviderDetailsArgs{
IdentityCenterConfig: &transfer.WebAppIdentityProviderDetailsIdentityCenterConfigArgs{
InstanceArn: pulumi.String(example.Arns[0]),
Role: exampleRole.Arn,
},
},
WebAppUnits: transfer.WebAppWebAppUnitArray{
&transfer.WebAppWebAppUnitArgs{
Provisioned: pulumi.Int(1),
},
},
Tags: pulumi.StringMap{
"Name": pulumi.String("test"),
},
})
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 current = Aws.GetCallerIdentity.Invoke();
var currentGetRegion = Aws.GetRegion.Invoke();
var currentGetPartition = Aws.GetPartition.Invoke();
var example = Aws.SsoAdmin.GetInstances.Invoke();
var assumeRoleTransfer = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Effect = "Allow",
Actions = new[]
{
"sts:AssumeRole",
"sts:SetContext",
},
Principals = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
{
Type = "Service",
Identifiers = new[]
{
"transfer.amazonaws.com",
},
},
},
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "aws:SourceAccount",
},
},
},
},
});
var exampleRole = new Aws.Iam.Role("example", new()
{
Name = "example",
AssumeRolePolicy = assumeRoleTransfer.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
var exampleGetPolicyDocument = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Effect = "Allow",
Actions = new[]
{
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
},
Resources = new[]
{
$"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:s3:{currentGetRegion.Apply(getRegionResult => getRegionResult.Name)}:{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:access-grants/*",
},
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "s3:ResourceAccount",
},
},
},
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Effect = "Allow",
Actions = new[]
{
"s3:ListAccessGrantsInstances",
},
Resources = new[]
{
"*",
},
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "s3:ResourceAccount",
},
},
},
},
});
var exampleRolePolicy = new Aws.Iam.RolePolicy("example", new()
{
Policy = exampleGetPolicyDocument.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
Role = exampleRole.Name,
});
var exampleWebApp = new Aws.Transfer.WebApp("example", new()
{
IdentityProviderDetails = new Aws.Transfer.Inputs.WebAppIdentityProviderDetailsArgs
{
IdentityCenterConfig = new Aws.Transfer.Inputs.WebAppIdentityProviderDetailsIdentityCenterConfigArgs
{
InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
Role = exampleRole.Arn,
},
},
WebAppUnits = new[]
{
new Aws.Transfer.Inputs.WebAppWebAppUnitArgs
{
Provisioned = 1,
},
},
Tags =
{
{ "Name", "test" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.inputs.GetPartitionArgs;
import com.pulumi.aws.ssoadmin.SsoadminFunctions;
import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicy;
import com.pulumi.aws.iam.RolePolicyArgs;
import com.pulumi.aws.transfer.WebApp;
import com.pulumi.aws.transfer.WebAppArgs;
import com.pulumi.aws.transfer.inputs.WebAppIdentityProviderDetailsArgs;
import com.pulumi.aws.transfer.inputs.WebAppIdentityProviderDetailsIdentityCenterConfigArgs;
import com.pulumi.aws.transfer.inputs.WebAppWebAppUnitArgs;
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 current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
.build());
final var currentGetRegion = AwsFunctions.getRegion(GetRegionArgs.builder()
.build());
final var currentGetPartition = AwsFunctions.getPartition(GetPartitionArgs.builder()
.build());
final var example = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
.build());
final var assumeRoleTransfer = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(GetPolicyDocumentStatementArgs.builder()
.effect("Allow")
.actions(
"sts:AssumeRole",
"sts:SetContext")
.principals(GetPolicyDocumentStatementPrincipalArgs.builder()
.type("Service")
.identifiers("transfer.amazonaws.com")
.build())
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("aws:SourceAccount")
.build())
.build())
.build());
var exampleRole = new Role("exampleRole", RoleArgs.builder()
.name("example")
.assumeRolePolicy(assumeRoleTransfer.json())
.build());
final var exampleGetPolicyDocument = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(
GetPolicyDocumentStatementArgs.builder()
.effect("Allow")
.actions(
"s3:GetDataAccess",
"s3:ListCallerAccessGrants")
.resources(String.format("arn:%s:s3:%s:%s:access-grants/*", currentGetPartition.partition(),currentGetRegion.name(),current.accountId()))
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("s3:ResourceAccount")
.build())
.build(),
GetPolicyDocumentStatementArgs.builder()
.effect("Allow")
.actions("s3:ListAccessGrantsInstances")
.resources("*")
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("s3:ResourceAccount")
.build())
.build())
.build());
var exampleRolePolicy = new RolePolicy("exampleRolePolicy", RolePolicyArgs.builder()
.policy(exampleGetPolicyDocument.json())
.role(exampleRole.name())
.build());
var exampleWebApp = new WebApp("exampleWebApp", WebAppArgs.builder()
.identityProviderDetails(WebAppIdentityProviderDetailsArgs.builder()
.identityCenterConfig(WebAppIdentityProviderDetailsIdentityCenterConfigArgs.builder()
.instanceArn(example.arns()[0])
.role(exampleRole.arn())
.build())
.build())
.webAppUnits(WebAppWebAppUnitArgs.builder()
.provisioned(1)
.build())
.tags(Map.of("Name", "test"))
.build());
}
}
resources:
exampleRole:
type: aws:iam:Role
name: example
properties:
name: example
assumeRolePolicy: ${assumeRoleTransfer.json}
exampleRolePolicy:
type: aws:iam:RolePolicy
name: example
properties:
policy: ${exampleGetPolicyDocument.json}
role: ${exampleRole.name}
exampleWebApp:
type: aws:transfer:WebApp
name: example
properties:
identityProviderDetails:
identityCenterConfig:
instanceArn: ${example.arns[0]}
role: ${exampleRole.arn}
webAppUnits:
- provisioned: 1
tags:
Name: test
variables:
current:
fn::invoke:
function: aws:getCallerIdentity
arguments: {}
currentGetRegion:
fn::invoke:
function: aws:getRegion
arguments: {}
currentGetPartition:
fn::invoke:
function: aws:getPartition
arguments: {}
example:
fn::invoke:
function: aws:ssoadmin:getInstances
arguments: {}
assumeRoleTransfer:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- effect: Allow
actions:
- sts:AssumeRole
- sts:SetContext
principals:
- type: Service
identifiers:
- transfer.amazonaws.com
conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: aws:SourceAccount
exampleGetPolicyDocument:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- effect: Allow
actions:
- s3:GetDataAccess
- s3:ListCallerAccessGrants
resources:
- arn:${currentGetPartition.partition}:s3:${currentGetRegion.name}:${current.accountId}:access-grants/*
conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: s3:ResourceAccount
- effect: Allow
actions:
- s3:ListAccessGrantsInstances
resources:
- '*'
conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: s3:ResourceAccount
Create WebApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebApp(name: string, args?: WebAppArgs, opts?: CustomResourceOptions);@overload
def WebApp(resource_name: str,
args: Optional[WebAppArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def WebApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_endpoint: Optional[str] = None,
identity_provider_details: Optional[WebAppIdentityProviderDetailsArgs] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
web_app_endpoint_policy: Optional[str] = None,
web_app_units: Optional[Sequence[WebAppWebAppUnitArgs]] = None)func NewWebApp(ctx *Context, name string, args *WebAppArgs, opts ...ResourceOption) (*WebApp, error)public WebApp(string name, WebAppArgs? args = null, CustomResourceOptions? opts = null)
public WebApp(String name, WebAppArgs args)
public WebApp(String name, WebAppArgs args, CustomResourceOptions options)
type: aws:transfer:WebApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WebAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WebAppArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WebAppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WebAppArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var webAppResource = new Aws.Transfer.WebApp("webAppResource", new()
{
AccessEndpoint = "string",
IdentityProviderDetails = new Aws.Transfer.Inputs.WebAppIdentityProviderDetailsArgs
{
IdentityCenterConfig = new Aws.Transfer.Inputs.WebAppIdentityProviderDetailsIdentityCenterConfigArgs
{
ApplicationArn = "string",
InstanceArn = "string",
Role = "string",
},
},
Region = "string",
Tags =
{
{ "string", "string" },
},
WebAppEndpointPolicy = "string",
WebAppUnits = new[]
{
new Aws.Transfer.Inputs.WebAppWebAppUnitArgs
{
Provisioned = 0,
},
},
});
example, err := transfer.NewWebApp(ctx, "webAppResource", &transfer.WebAppArgs{
AccessEndpoint: pulumi.String("string"),
IdentityProviderDetails: &transfer.WebAppIdentityProviderDetailsArgs{
IdentityCenterConfig: &transfer.WebAppIdentityProviderDetailsIdentityCenterConfigArgs{
ApplicationArn: pulumi.String("string"),
InstanceArn: pulumi.String("string"),
Role: pulumi.String("string"),
},
},
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
WebAppEndpointPolicy: pulumi.String("string"),
WebAppUnits: transfer.WebAppWebAppUnitArray{
&transfer.WebAppWebAppUnitArgs{
Provisioned: pulumi.Int(0),
},
},
})
var webAppResource = new WebApp("webAppResource", WebAppArgs.builder()
.accessEndpoint("string")
.identityProviderDetails(WebAppIdentityProviderDetailsArgs.builder()
.identityCenterConfig(WebAppIdentityProviderDetailsIdentityCenterConfigArgs.builder()
.applicationArn("string")
.instanceArn("string")
.role("string")
.build())
.build())
.region("string")
.tags(Map.of("string", "string"))
.webAppEndpointPolicy("string")
.webAppUnits(WebAppWebAppUnitArgs.builder()
.provisioned(0)
.build())
.build());
web_app_resource = aws.transfer.WebApp("webAppResource",
access_endpoint="string",
identity_provider_details={
"identity_center_config": {
"application_arn": "string",
"instance_arn": "string",
"role": "string",
},
},
region="string",
tags={
"string": "string",
},
web_app_endpoint_policy="string",
web_app_units=[{
"provisioned": 0,
}])
const webAppResource = new aws.transfer.WebApp("webAppResource", {
accessEndpoint: "string",
identityProviderDetails: {
identityCenterConfig: {
applicationArn: "string",
instanceArn: "string",
role: "string",
},
},
region: "string",
tags: {
string: "string",
},
webAppEndpointPolicy: "string",
webAppUnits: [{
provisioned: 0,
}],
});
type: aws:transfer:WebApp
properties:
accessEndpoint: string
identityProviderDetails:
identityCenterConfig:
applicationArn: string
instanceArn: string
role: string
region: string
tags:
string: string
webAppEndpointPolicy: string
webAppUnits:
- provisioned: 0
WebApp Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WebApp resource accepts the following input properties:
- Access
Endpoint string - URL provided to interact with the Transfer Family web app.
- Identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Key-value pairs that can be used to group and search for web apps.
- Web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - Web
App List<WebUnits App Web App Unit> - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- Access
Endpoint string - URL provided to interact with the Transfer Family web app.
- Identity
Provider WebDetails App Identity Provider Details Args Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Key-value pairs that can be used to group and search for web apps.
- Web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - Web
App []WebUnits App Web App Unit Args - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint String - URL provided to interact with the Transfer Family web app.
- identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Key-value pairs that can be used to group and search for web apps.
- web
App StringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App List<WebUnits App Web App Unit> - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint string - URL provided to interact with the Transfer Family web app.
- identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Key-value pairs that can be used to group and search for web apps.
- web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App WebUnits App Web App Unit[] - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access_
endpoint str - URL provided to interact with the Transfer Family web app.
- identity_
provider_ Webdetails App Identity Provider Details Args Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Key-value pairs that can be used to group and search for web apps.
- web_
app_ strendpoint_ policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web_
app_ Sequence[Webunits App Web App Unit Args] - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint String - URL provided to interact with the Transfer Family web app.
- identity
Provider Property MapDetails Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Key-value pairs that can be used to group and search for web apps.
- web
App StringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App List<Property Map>Units - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
Outputs
All input properties are implicitly available as output properties. Additionally, the WebApp resource produces the following output properties:
- arn str
- ARN of the Web App.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- web_
app_ strid - ID of the Wep App resource.
Look up Existing WebApp Resource
Get an existing WebApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: WebAppState, opts?: CustomResourceOptions): WebApp@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_endpoint: Optional[str] = None,
arn: Optional[str] = None,
identity_provider_details: Optional[WebAppIdentityProviderDetailsArgs] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
web_app_endpoint_policy: Optional[str] = None,
web_app_id: Optional[str] = None,
web_app_units: Optional[Sequence[WebAppWebAppUnitArgs]] = None) -> WebAppfunc GetWebApp(ctx *Context, name string, id IDInput, state *WebAppState, opts ...ResourceOption) (*WebApp, error)public static WebApp Get(string name, Input<string> id, WebAppState? state, CustomResourceOptions? opts = null)public static WebApp get(String name, Output<String> id, WebAppState state, CustomResourceOptions options)resources: _: type: aws:transfer:WebApp get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Endpoint string - URL provided to interact with the Transfer Family web app.
- Arn string
- ARN of the Web App.
- Identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Key-value pairs that can be used to group and search for web apps.
- Dictionary<string, string>
- Web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - Web
App stringId - ID of the Wep App resource.
- Web
App List<WebUnits App Web App Unit> - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- Access
Endpoint string - URL provided to interact with the Transfer Family web app.
- Arn string
- ARN of the Web App.
- Identity
Provider WebDetails App Identity Provider Details Args Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Key-value pairs that can be used to group and search for web apps.
- map[string]string
- Web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - Web
App stringId - ID of the Wep App resource.
- Web
App []WebUnits App Web App Unit Args - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint String - URL provided to interact with the Transfer Family web app.
- arn String
- ARN of the Web App.
- identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Key-value pairs that can be used to group and search for web apps.
- Map<String,String>
- web
App StringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App StringId - ID of the Wep App resource.
- web
App List<WebUnits App Web App Unit> - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint string - URL provided to interact with the Transfer Family web app.
- arn string
- ARN of the Web App.
- identity
Provider WebDetails App Identity Provider Details Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Key-value pairs that can be used to group and search for web apps.
- {[key: string]: string}
- web
App stringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App stringId - ID of the Wep App resource.
- web
App WebUnits App Web App Unit[] - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access_
endpoint str - URL provided to interact with the Transfer Family web app.
- arn str
- ARN of the Web App.
- identity_
provider_ Webdetails App Identity Provider Details Args Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Key-value pairs that can be used to group and search for web apps.
- Mapping[str, str]
- web_
app_ strendpoint_ policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web_
app_ strid - ID of the Wep App resource.
- web_
app_ Sequence[Webunits App Web App Unit Args] - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
- access
Endpoint String - URL provided to interact with the Transfer Family web app.
- arn String
- ARN of the Web App.
- identity
Provider Property MapDetails Block for details of the identity provider to use with the web app. See Identity provider details below.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Key-value pairs that can be used to group and search for web apps.
- Map<String>
- web
App StringEndpoint Policy - Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS. - web
App StringId - ID of the Wep App resource.
- web
App List<Property Map>Units - Block for number of concurrent connections or the user sessions on the web app.
- provisioned - (Optional) Number of units of concurrent connections.
Supporting Types
WebAppIdentityProviderDetails, WebAppIdentityProviderDetailsArgs
- Identity
Center WebConfig App Identity Provider Details Identity Center Config - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
- Identity
Center WebConfig App Identity Provider Details Identity Center Config - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
- identity
Center WebConfig App Identity Provider Details Identity Center Config - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
- identity
Center WebConfig App Identity Provider Details Identity Center Config - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
- identity_
center_ Webconfig App Identity Provider Details Identity Center Config - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
- identity
Center Property MapConfig - Block that describes the values to use for the IAM Identity Center settings. See Identity center config below.
WebAppIdentityProviderDetailsIdentityCenterConfig, WebAppIdentityProviderDetailsIdentityCenterConfigArgs
- Application
Arn string - Instance
Arn string - ARN of the IAM Identity Center used for the web app.
- Role string
- ARN of an identity bearer role for your web app.
- Application
Arn string - Instance
Arn string - ARN of the IAM Identity Center used for the web app.
- Role string
- ARN of an identity bearer role for your web app.
- application
Arn String - instance
Arn String - ARN of the IAM Identity Center used for the web app.
- role String
- ARN of an identity bearer role for your web app.
- application
Arn string - instance
Arn string - ARN of the IAM Identity Center used for the web app.
- role string
- ARN of an identity bearer role for your web app.
- application_
arn str - instance_
arn str - ARN of the IAM Identity Center used for the web app.
- role str
- ARN of an identity bearer role for your web app.
- application
Arn String - instance
Arn String - ARN of the IAM Identity Center used for the web app.
- role String
- ARN of an identity bearer role for your web app.
WebAppWebAppUnit, WebAppWebAppUnitArgs
- Provisioned int
- Provisioned int
- provisioned Integer
- provisioned number
- provisioned int
- provisioned Number
Import
Using pulumi import, import Transfer Family Web App using the web_app_id. For example:
$ pulumi import aws:transfer/webApp:WebApp example web_app-id-12345678
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
