com.pulumi.aws.transfer.kotlin.UserArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.transfer.kotlin
import com.pulumi.aws.transfer.UserArgs.builder
import com.pulumi.aws.transfer.kotlin.inputs.UserHomeDirectoryMappingArgs
import com.pulumi.aws.transfer.kotlin.inputs.UserHomeDirectoryMappingArgsBuilder
import com.pulumi.aws.transfer.kotlin.inputs.UserPosixProfileArgs
import com.pulumi.aws.transfer.kotlin.inputs.UserPosixProfileArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const fooServer = new aws.transfer.Server("foo", {
* identityProviderType: "SERVICE_MANAGED",
* tags: {
* NAME: "tf-acc-test-transfer-server",
* },
* });
* const assumeRole = aws.iam.getPolicyDocument({
* statements: [{
* effect: "Allow",
* principals: [{
* type: "Service",
* identifiers: ["transfer.amazonaws.com"],
* }],
* actions: ["sts:AssumeRole"],
* }],
* });
* const fooRole = new aws.iam.Role("foo", {
* name: "tf-test-transfer-user-iam-role",
* assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
* });
* const foo = aws.iam.getPolicyDocument({
* statements: [{
* sid: "AllowFullAccesstoS3",
* effect: "Allow",
* actions: ["s3:*"],
* resources: ["*"],
* }],
* });
* const fooRolePolicy = new aws.iam.RolePolicy("foo", {
* name: "tf-test-transfer-user-iam-policy",
* role: fooRole.id,
* policy: foo.then(foo => foo.json),
* });
* const fooUser = new aws.transfer.User("foo", {
* serverId: fooServer.id,
* userName: "tftestuser",
* role: fooRole.arn,
* homeDirectoryType: "LOGICAL",
* homeDirectoryMappings: [{
* entry: "/test.pdf",
* target: "/bucket3/test-path/tftestuser.pdf",
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* foo_server = aws.transfer.Server("foo",
* identity_provider_type="SERVICE_MANAGED",
* tags={
* "NAME": "tf-acc-test-transfer-server",
* })
* assume_role = aws.iam.get_policy_document(statements=[{
* "effect": "Allow",
* "principals": [{
* "type": "Service",
* "identifiers": ["transfer.amazonaws.com"],
* }],
* "actions": ["sts:AssumeRole"],
* }])
* foo_role = aws.iam.Role("foo",
* name="tf-test-transfer-user-iam-role",
* assume_role_policy=assume_role.json)
* foo = aws.iam.get_policy_document(statements=[{
* "sid": "AllowFullAccesstoS3",
* "effect": "Allow",
* "actions": ["s3:*"],
* "resources": ["*"],
* }])
* foo_role_policy = aws.iam.RolePolicy("foo",
* name="tf-test-transfer-user-iam-policy",
* role=foo_role.id,
* policy=foo.json)
* foo_user = aws.transfer.User("foo",
* server_id=foo_server.id,
* user_name="tftestuser",
* role=foo_role.arn,
* home_directory_type="LOGICAL",
* home_directory_mappings=[{
* "entry": "/test.pdf",
* "target": "/bucket3/test-path/tftestuser.pdf",
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var fooServer = new Aws.Transfer.Server("foo", new()
* {
* IdentityProviderType = "SERVICE_MANAGED",
* Tags =
* {
* { "NAME", "tf-acc-test-transfer-server" },
* },
* });
* var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
* {
* Statements = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
* {
* Effect = "Allow",
* Principals = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
* {
* Type = "Service",
* Identifiers = new[]
* {
* "transfer.amazonaws.com",
* },
* },
* },
* Actions = new[]
* {
* "sts:AssumeRole",
* },
* },
* },
* });
* var fooRole = new Aws.Iam.Role("foo", new()
* {
* Name = "tf-test-transfer-user-iam-role",
* AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
* });
* var foo = Aws.Iam.GetPolicyDocument.Invoke(new()
* {
* Statements = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
* {
* Sid = "AllowFullAccesstoS3",
* Effect = "Allow",
* Actions = new[]
* {
* "s3:*",
* },
* Resources = new[]
* {
* "*",
* },
* },
* },
* });
* var fooRolePolicy = new Aws.Iam.RolePolicy("foo", new()
* {
* Name = "tf-test-transfer-user-iam-policy",
* Role = fooRole.Id,
* Policy = foo.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
* });
* var fooUser = new Aws.Transfer.User("foo", new()
* {
* ServerId = fooServer.Id,
* UserName = "tftestuser",
* Role = fooRole.Arn,
* HomeDirectoryType = "LOGICAL",
* HomeDirectoryMappings = new[]
* {
* new Aws.Transfer.Inputs.UserHomeDirectoryMappingArgs
* {
* Entry = "/test.pdf",
* Target = "/bucket3/test-path/tftestuser.pdf",
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/transfer"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* fooServer, err := transfer.NewServer(ctx, "foo", &transfer.ServerArgs{
* IdentityProviderType: pulumi.String("SERVICE_MANAGED"),
* Tags: pulumi.StringMap{
* "NAME": pulumi.String("tf-acc-test-transfer-server"),
* },
* })
* if err != nil {
* return err
* }
* assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
* Statements: []iam.GetPolicyDocumentStatement{
* {
* Effect: pulumi.StringRef("Allow"),
* Principals: []iam.GetPolicyDocumentStatementPrincipal{
* {
* Type: "Service",
* Identifiers: []string{
* "transfer.amazonaws.com",
* },
* },
* },
* Actions: []string{
* "sts:AssumeRole",
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* fooRole, err := iam.NewRole(ctx, "foo", &iam.RoleArgs{
* Name: pulumi.String("tf-test-transfer-user-iam-role"),
* AssumeRolePolicy: pulumi.String(assumeRole.Json),
* })
* if err != nil {
* return err
* }
* foo, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
* Statements: []iam.GetPolicyDocumentStatement{
* {
* Sid: pulumi.StringRef("AllowFullAccesstoS3"),
* Effect: pulumi.StringRef("Allow"),
* Actions: []string{
* "s3:*",
* },
* Resources: []string{
* "*",
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* _, err = iam.NewRolePolicy(ctx, "foo", &iam.RolePolicyArgs{
* Name: pulumi.String("tf-test-transfer-user-iam-policy"),
* Role: fooRole.ID(),
* Policy: pulumi.String(foo.Json),
* })
* if err != nil {
* return err
* }
* _, err = transfer.NewUser(ctx, "foo", &transfer.UserArgs{
* ServerId: fooServer.ID(),
* UserName: pulumi.String("tftestuser"),
* Role: fooRole.Arn,
* HomeDirectoryType: pulumi.String("LOGICAL"),
* HomeDirectoryMappings: transfer.UserHomeDirectoryMappingArray{
* &transfer.UserHomeDirectoryMappingArgs{
* Entry: pulumi.String("/test.pdf"),
* Target: pulumi.String("/bucket3/test-path/tftestuser.pdf"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.transfer.Server;
* import com.pulumi.aws.transfer.ServerArgs;
* 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.User;
* import com.pulumi.aws.transfer.UserArgs;
* import com.pulumi.aws.transfer.inputs.UserHomeDirectoryMappingArgs;
* 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) {
* var fooServer = new Server("fooServer", ServerArgs.builder()
* .identityProviderType("SERVICE_MANAGED")
* .tags(Map.of("NAME", "tf-acc-test-transfer-server"))
* .build());
* final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
* .statements(GetPolicyDocumentStatementArgs.builder()
* .effect("Allow")
* .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
* .type("Service")
* .identifiers("transfer.amazonaws.com")
* .build())
* .actions("sts:AssumeRole")
* .build())
* .build());
* var fooRole = new Role("fooRole", RoleArgs.builder()
* .name("tf-test-transfer-user-iam-role")
* .assumeRolePolicy(assumeRole.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
* .build());
* final var foo = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
* .statements(GetPolicyDocumentStatementArgs.builder()
* .sid("AllowFullAccesstoS3")
* .effect("Allow")
* .actions("s3:*")
* .resources("*")
* .build())
* .build());
* var fooRolePolicy = new RolePolicy("fooRolePolicy", RolePolicyArgs.builder()
* .name("tf-test-transfer-user-iam-policy")
* .role(fooRole.id())
* .policy(foo.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
* .build());
* var fooUser = new User("fooUser", UserArgs.builder()
* .serverId(fooServer.id())
* .userName("tftestuser")
* .role(fooRole.arn())
* .homeDirectoryType("LOGICAL")
* .homeDirectoryMappings(UserHomeDirectoryMappingArgs.builder()
* .entry("/test.pdf")
* .target("/bucket3/test-path/tftestuser.pdf")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* fooServer:
* type: aws:transfer:Server
* name: foo
* properties:
* identityProviderType: SERVICE_MANAGED
* tags:
* NAME: tf-acc-test-transfer-server
* fooRole:
* type: aws:iam:Role
* name: foo
* properties:
* name: tf-test-transfer-user-iam-role
* assumeRolePolicy: ${assumeRole.json}
* fooRolePolicy:
* type: aws:iam:RolePolicy
* name: foo
* properties:
* name: tf-test-transfer-user-iam-policy
* role: ${fooRole.id}
* policy: ${foo.json}
* fooUser:
* type: aws:transfer:User
* name: foo
* properties:
* serverId: ${fooServer.id}
* userName: tftestuser
* role: ${fooRole.arn}
* homeDirectoryType: LOGICAL
* homeDirectoryMappings:
* - entry: /test.pdf
* target: /bucket3/test-path/tftestuser.pdf
* variables:
* assumeRole:
* fn::invoke:
* Function: aws:iam:getPolicyDocument
* Arguments:
* statements:
* - effect: Allow
* principals:
* - type: Service
* identifiers:
* - transfer.amazonaws.com
* actions:
* - sts:AssumeRole
* foo:
* fn::invoke:
* Function: aws:iam:getPolicyDocument
* Arguments:
* statements:
* - sid: AllowFullAccesstoS3
* effect: Allow
* actions:
* - s3:*
* resources:
* - '*'
* ```
*
* ## Import
* Using `pulumi import`, import Transfer Users using the `server_id` and `user_name` separated by `/`. For example:
* ```sh
* $ pulumi import aws:transfer/user:User bar s-12345678/test-username
* ```
* @property homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`.
* @property homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.
* @property homeDirectoryType The type of landing directory (folder) you mapped for your users' home directory. Valid values are `PATH` and `LOGICAL`.
* @property policy An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`. These are evaluated on-the-fly when navigating the bucket.
* @property posixProfile Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.
* @property role Amazon Resource Name (ARN) of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket.
* @property serverId The Server ID of the Transfer Server (e.g., `s-12345678`)
* @property tags A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block, tags with matching keys will overwrite those defined at the provider-level.
* @property userName The name used for log in to your SFTP server.
*/
public data class UserArgs(
public val homeDirectory: Output? = null,
public val homeDirectoryMappings: Output>? = null,
public val homeDirectoryType: Output? = null,
public val policy: Output? = null,
public val posixProfile: Output? = null,
public val role: Output? = null,
public val serverId: Output? = null,
public val tags: Output
© 2015 - 2024 Weber Informatics LLC | Privacy Policy