WebApp class
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: [{
conditions: [{
test: "StringEquals",
values: [current.accountId],
variable: "aws:SourceAccount",
}],
principals: [{
type: "Service",
identifiers: ["transfer.amazonaws.com"],
}],
effect: "Allow",
actions: [
"sts:AssumeRole",
"sts:SetContext",
],
}],
}));
const exampleRole = new aws.iam.Role("example", {
name: "example",
assumeRolePolicy: assumeRoleTransfer.then(assumeRoleTransfer => assumeRoleTransfer.json),
});
const exampleGetPolicyDocument = Promise.all([current, currentGetPartition, currentGetRegion]).then(([current, currentGetPartition, currentGetRegion]) => aws.iam.getPolicyDocument({
statements: [
{
conditions: [{
test: "StringEquals",
values: [current.accountId],
variable: "s3:ResourceAccount",
}],
effect: "Allow",
actions: [
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
],
resources: [`arn:${currentGetPartition.partition}:s3:${currentGetRegion.region}:${current.accountId}:access-grants/*`],
},
{
conditions: [{
test: "StringEquals",
values: [current.accountId],
variable: "s3:ResourceAccount",
}],
effect: "Allow",
actions: ["s3:ListAccessGrantsInstances"],
resources: ["*"],
},
],
}));
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=[{
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "aws:SourceAccount",
}],
"principals": [{
"type": "Service",
"identifiers": ["transfer.amazonaws.com"],
}],
"effect": "Allow",
"actions": [
"sts:AssumeRole",
"sts:SetContext",
],
}])
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=[
{
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "s3:ResourceAccount",
}],
"effect": "Allow",
"actions": [
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
],
"resources": [f"arn:{current_get_partition.partition}:s3:{current_get_region.region}:{current.account_id}:access-grants/*"],
},
{
"conditions": [{
"test": "StringEquals",
"values": [current.account_id],
"variable": "s3:ResourceAccount",
}],
"effect": "Allow",
"actions": ["s3:ListAccessGrantsInstances"],
"resources": ["*"],
},
])
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",
})
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
{
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "aws:SourceAccount",
},
},
Principals = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
{
Type = "Service",
Identifiers = new[]
{
"transfer.amazonaws.com",
},
},
},
Effect = "Allow",
Actions = new[]
{
"sts:AssumeRole",
"sts:SetContext",
},
},
},
});
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
{
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "s3:ResourceAccount",
},
},
Effect = "Allow",
Actions = new[]
{
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
},
Resources = new[]
{
$"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:s3:{currentGetRegion.Apply(getRegionResult => getRegionResult.Region)}:{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:access-grants/*",
},
},
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Conditions = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
{
Test = "StringEquals",
Values = new[]
{
current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
Variable = "s3:ResourceAccount",
},
},
Effect = "Allow",
Actions = new[]
{
"s3:ListAccessGrantsInstances",
},
Resources = new[]
{
"*",
},
},
},
});
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 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{
{
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: pulumi.StringArray{
current.AccountId,
},
Variable: "aws:SourceAccount",
},
},
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "Service",
Identifiers: []string{
"transfer.amazonaws.com",
},
},
},
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"sts:AssumeRole",
"sts:SetContext",
},
},
},
}, 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{
{
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: pulumi.StringArray{
current.AccountId,
},
Variable: "s3:ResourceAccount",
},
},
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"s3:GetDataAccess",
"s3:ListCallerAccessGrants",
},
Resources: []string{
fmt.Sprintf("arn:%v:s3:%v:%v:access-grants/*", currentGetPartition.Partition, currentGetRegion.Region, current.AccountId),
},
},
{
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Values: pulumi.StringArray{
current.AccountId,
},
Variable: "s3:ResourceAccount",
},
},
Effect: pulumi.StringRef("Allow"),
Actions: []string{
"s3:ListAccessGrantsInstances",
},
Resources: []string{
"*",
},
},
},
}, 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getcalleridentity" "current" {
}
data "aws_getregion" "currentGetRegion" {
}
data "aws_getpartition" "currentGetPartition" {
}
data "aws_ssoadmin_getinstances" "example" {
}
data "aws_iam_getpolicydocument" "assumeRoleTransfer" {
statements {
conditions {
test = "StringEquals"
values = [data.aws_getcalleridentity.current.account_id]
variable = "aws:SourceAccount"
}
principals {
type = "Service"
identifiers = ["transfer.amazonaws.com"]
}
effect = "Allow"
actions = ["sts:AssumeRole", "sts:SetContext"]
}
}
data "aws_iam_getpolicydocument" "exampleGetPolicyDocument" {
statements {
conditions {
test = "StringEquals"
values = [data.aws_getcalleridentity.current.account_id]
variable = "s3:ResourceAccount"
}
effect = "Allow"
actions = ["s3:GetDataAccess", "s3:ListCallerAccessGrants"]
resources = ["arn:${data.aws_getpartition.currentGetPartition.partition}:s3:${data.aws_getregion.currentGetRegion.region}:${data.aws_getcalleridentity.current.account_id}:access-grants/*"]
}
statements {
conditions {
test = "StringEquals"
values = [data.aws_getcalleridentity.current.account_id]
variable = "s3:ResourceAccount"
}
effect = "Allow"
actions = ["s3:ListAccessGrantsInstances"]
resources = ["*"]
}
}
resource "aws_iam_role" "example" {
name = "example"
assume_role_policy = data.aws_iam_getpolicydocument.assumeRoleTransfer.json
}
resource "aws_iam_rolepolicy" "example" {
policy = data.aws_iam_getpolicydocument.exampleGetPolicyDocument.json
role = aws_iam_role.example.name
}
resource "aws_transfer_webapp" "example" {
identity_provider_details = {
identity_center_config = {
instance_arn = data.aws_ssoadmin_getinstances.example.arns[0]
role = aws_iam_role.example.arn
}
}
web_app_units {
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.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
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.ArrayList;
import java.util.Arrays;
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()
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("aws:SourceAccount")
.build())
.principals(GetPolicyDocumentStatementPrincipalArgs.builder()
.type("Service")
.identifiers("transfer.amazonaws.com")
.build())
.effect("Allow")
.actions(
"sts:AssumeRole",
"sts:SetContext")
.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()
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("s3:ResourceAccount")
.build())
.effect("Allow")
.actions(
"s3:GetDataAccess",
"s3:ListCallerAccessGrants")
.resources(String.format("arn:%s:s3:%s:%s:access-grants/*", currentGetPartition.partition(),currentGetRegion.region(),current.accountId()))
.build(),
GetPolicyDocumentStatementArgs.builder()
.conditions(GetPolicyDocumentStatementConditionArgs.builder()
.test("StringEquals")
.values(current.accountId())
.variable("s3:ResourceAccount")
.build())
.effect("Allow")
.actions("s3:ListAccessGrantsInstances")
.resources("*")
.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:
- conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: aws:SourceAccount
principals:
- type: Service
identifiers:
- transfer.amazonaws.com
effect: Allow
actions:
- sts:AssumeRole
- sts:SetContext
exampleGetPolicyDocument:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: s3:ResourceAccount
effect: Allow
actions:
- s3:GetDataAccess
- s3:ListCallerAccessGrants
resources:
- arn:${currentGetPartition.partition}:s3:${currentGetRegion.region}:${current.accountId}:access-grants/*
- conditions:
- test: StringEquals
values:
- ${current.accountId}
variable: s3:ResourceAccount
effect: Allow
actions:
- s3:ListAccessGrantsInstances
resources:
- '*'
Import
Using pulumi import, import Transfer Family Web App using the webAppId. For example:
$ pulumi import aws:transfer/webApp:WebApp example web_app-id-12345678
Constructors
- WebApp(String name, {WebAppArgs? args, CustomResourceOptions? options})
-
Creates a new WebApp.
nameThe Pulumi resource name.argsArguments used to configure this WebApp. The set of arguments for WebApp.optionsResource options controlling this resource's behavior. - WebApp.reference(String urn)
- Creates a typed reference to an existing WebApp resource.
Properties
-
accessEndpoint
↔ Output<
String> -
URL provided to interact with the Transfer Family web app. If
endpoint_details.vpcblock is specified,accessEndpointmust not be provided.latefinal -
arn
↔ Output<
String> -
ARN of the Web App.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpointDetails
↔ Output<
WebAppEndpointDetails?> -
Block for the endpoint configuration for the web app. If not specified, the web app will be created with a public endpoint. See
endpointDetailsBlock below.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identityProviderDetails
↔ Output<
WebAppIdentityProviderDetails> -
Block for details of the identity provider to use with the web app. See
identityProviderDetailsBlock below.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value pairs that can be used to group and search for web apps.
latefinal
-
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
webAppEndpointPolicy
↔ Output<
String> -
Type of endpoint policy for the web app. Valid values are:
STANDARD(default) orFIPS.latefinal -
webAppId
↔ Output<
String> -
ID of the Web App resource.
latefinal
-
webAppUnits
↔ Output<
List< WebAppWebAppUnit> > -
Block for number of concurrent connections or the user sessions on the web app. See
webAppUnitsBlock below.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited