Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datasync
  5. LocationS3

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.datasync.LocationS3

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::DataSync::LocationS3

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var locationS3 = new AwsNative.DataSync.LocationS3("locationS3", new()
    {
        S3BucketArn = "arn:aws:s3:::MyBucket",
        S3Config = new AwsNative.DataSync.Inputs.LocationS3s3ConfigArgs
        {
            BucketAccessRoleArn = "arn:aws:iam::111222333444:role/MyBucketAccessRole",
        },
        S3StorageClass = AwsNative.DataSync.LocationS3S3StorageClass.Standard,
        Subdirectory = "/MyFolder",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationS3(ctx, "locationS3", &datasync.LocationS3Args{
			S3BucketArn: pulumi.String("arn:aws:s3:::MyBucket"),
			S3Config: &datasync.LocationS3s3ConfigArgs{
				BucketAccessRoleArn: pulumi.String("arn:aws:iam::111222333444:role/MyBucketAccessRole"),
			},
			S3StorageClass: datasync.LocationS3S3StorageClassStandard,
			Subdirectory:   pulumi.String("/MyFolder"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

location_s3 = aws_native.datasync.LocationS3("locationS3",
    s3_bucket_arn="arn:aws:s3:::MyBucket",
    s3_config={
        "bucket_access_role_arn": "arn:aws:iam::111222333444:role/MyBucketAccessRole",
    },
    s3_storage_class=aws_native.datasync.LocationS3S3StorageClass.STANDARD,
    subdirectory="/MyFolder")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const locationS3 = new aws_native.datasync.LocationS3("locationS3", {
    s3BucketArn: "arn:aws:s3:::MyBucket",
    s3Config: {
        bucketAccessRoleArn: "arn:aws:iam::111222333444:role/MyBucketAccessRole",
    },
    s3StorageClass: aws_native.datasync.LocationS3S3StorageClass.Standard,
    subdirectory: "/MyFolder",
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var locationS3 = new AwsNative.DataSync.LocationS3("locationS3", new()
    {
        S3BucketArn = "arn:aws:s3:::MyBucket",
        S3Config = new AwsNative.DataSync.Inputs.LocationS3s3ConfigArgs
        {
            BucketAccessRoleArn = "arn:aws:iam::111222333444:role/MyBucketAccessRole",
        },
        S3StorageClass = AwsNative.DataSync.LocationS3S3StorageClass.Standard,
        Subdirectory = "/MyFolder",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationS3(ctx, "locationS3", &datasync.LocationS3Args{
			S3BucketArn: pulumi.String("arn:aws:s3:::MyBucket"),
			S3Config: &datasync.LocationS3s3ConfigArgs{
				BucketAccessRoleArn: pulumi.String("arn:aws:iam::111222333444:role/MyBucketAccessRole"),
			},
			S3StorageClass: datasync.LocationS3S3StorageClassStandard,
			Subdirectory:   pulumi.String("/MyFolder"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

location_s3 = aws_native.datasync.LocationS3("locationS3",
    s3_bucket_arn="arn:aws:s3:::MyBucket",
    s3_config={
        "bucket_access_role_arn": "arn:aws:iam::111222333444:role/MyBucketAccessRole",
    },
    s3_storage_class=aws_native.datasync.LocationS3S3StorageClass.STANDARD,
    subdirectory="/MyFolder")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const locationS3 = new aws_native.datasync.LocationS3("locationS3", {
    s3BucketArn: "arn:aws:s3:::MyBucket",
    s3Config: {
        bucketAccessRoleArn: "arn:aws:iam::111222333444:role/MyBucketAccessRole",
    },
    s3StorageClass: aws_native.datasync.LocationS3S3StorageClass.Standard,
    subdirectory: "/MyFolder",
});

    Coming soon!

    Create LocationS3 Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LocationS3(name: string, args: LocationS3Args, opts?: CustomResourceOptions);
    @overload
def LocationS3(resource_name: str,
               args: LocationS3Args,
               opts: Optional[ResourceOptions] = None)

@overload
def LocationS3(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               s3_config: Optional[LocationS3s3ConfigArgs] = None,
               s3_bucket_arn: Optional[str] = None,
               s3_storage_class: Optional[LocationS3S3StorageClass] = None,
               subdirectory: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewLocationS3(ctx *Context, name string, args LocationS3Args, opts ...ResourceOption) (*LocationS3, error)
    public LocationS3(string name, LocationS3Args args, CustomResourceOptions? opts = null)
    public LocationS3(String name, LocationS3Args args)
public LocationS3(String name, LocationS3Args args, CustomResourceOptions options)

    type: aws-native:datasync:LocationS3
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 LocationS3Args
    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 LocationS3Args
    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 LocationS3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocationS3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocationS3Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LocationS3 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 LocationS3 resource accepts the following input properties:

    S3Config Pulumi.AwsNative.DataSync.Inputs.LocationS3s3Config

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    S3BucketArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    S3StorageClass Pulumi.AwsNative.DataSync.LocationS3S3StorageClass
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    Subdirectory string
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    S3Config LocationS3s3ConfigArgs

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    S3BucketArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    S3StorageClass LocationS3S3StorageClass
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    Subdirectory string
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    s3Config LocationS3s3Config

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    s3BucketArn String
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    s3StorageClass LocationS3S3StorageClass
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    subdirectory String
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    s3Config LocationS3s3Config

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    s3BucketArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    s3StorageClass LocationS3S3StorageClass
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    subdirectory string
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    s3_config LocationS3s3ConfigArgs

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    s3_bucket_arn str
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    s3_storage_class LocationS3S3StorageClass
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    subdirectory str
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    s3Config Property Map

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

    s3BucketArn String
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    s3StorageClass "STANDARD" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "DEEP_ARCHIVE"
    The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
    subdirectory String
    A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocationS3 resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    LocationUri string
    The URL of the S3 location that was described.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    LocationUri string
    The URL of the S3 location that was described.
    id String
    The provider-assigned unique ID for this managed resource.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    locationUri String
    The URL of the S3 location that was described.
    id string
    The provider-assigned unique ID for this managed resource.
    locationArn string
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    locationUri string
    The URL of the S3 location that was described.
    id str
    The provider-assigned unique ID for this managed resource.
    location_arn str
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    location_uri str
    The URL of the S3 location that was described.
    id String
    The provider-assigned unique ID for this managed resource.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    locationUri String
    The URL of the S3 location that was described.

    Supporting Types

    LocationS3S3StorageClass, LocationS3S3StorageClassArgs

    Standard
    STANDARD
    StandardIa
    STANDARD_IA
    OnezoneIa
    ONEZONE_IA
    IntelligentTiering
    INTELLIGENT_TIERING
    Glacier
    GLACIER
    GlacierInstantRetrieval
    GLACIER_INSTANT_RETRIEVAL
    DeepArchive
    DEEP_ARCHIVE
    LocationS3S3StorageClassStandard
    STANDARD
    LocationS3S3StorageClassStandardIa
    STANDARD_IA
    LocationS3S3StorageClassOnezoneIa
    ONEZONE_IA
    LocationS3S3StorageClassIntelligentTiering
    INTELLIGENT_TIERING
    LocationS3S3StorageClassGlacier
    GLACIER
    LocationS3S3StorageClassGlacierInstantRetrieval
    GLACIER_INSTANT_RETRIEVAL
    LocationS3S3StorageClassDeepArchive
    DEEP_ARCHIVE
    Standard
    STANDARD
    StandardIa
    STANDARD_IA
    OnezoneIa
    ONEZONE_IA
    IntelligentTiering
    INTELLIGENT_TIERING
    Glacier
    GLACIER
    GlacierInstantRetrieval
    GLACIER_INSTANT_RETRIEVAL
    DeepArchive
    DEEP_ARCHIVE
    Standard
    STANDARD
    StandardIa
    STANDARD_IA
    OnezoneIa
    ONEZONE_IA
    IntelligentTiering
    INTELLIGENT_TIERING
    Glacier
    GLACIER
    GlacierInstantRetrieval
    GLACIER_INSTANT_RETRIEVAL
    DeepArchive
    DEEP_ARCHIVE
    STANDARD
    STANDARD
    STANDARD_IA
    STANDARD_IA
    ONEZONE_IA
    ONEZONE_IA
    INTELLIGENT_TIERING
    INTELLIGENT_TIERING
    GLACIER
    GLACIER
    GLACIER_INSTANT_RETRIEVAL
    GLACIER_INSTANT_RETRIEVAL
    DEEP_ARCHIVE
    DEEP_ARCHIVE
    "STANDARD"
    STANDARD
    "STANDARD_IA"
    STANDARD_IA
    "ONEZONE_IA"
    ONEZONE_IA
    "INTELLIGENT_TIERING"
    INTELLIGENT_TIERING
    "GLACIER"
    GLACIER
    "GLACIER_INSTANT_RETRIEVAL"
    GLACIER_INSTANT_RETRIEVAL
    "DEEP_ARCHIVE"
    DEEP_ARCHIVE

    LocationS3s3Config, LocationS3s3ConfigArgs

    BucketAccessRoleArn string
    The ARN of the IAM role of the Amazon S3 bucket.
    BucketAccessRoleArn string
    The ARN of the IAM role of the Amazon S3 bucket.
    bucketAccessRoleArn String
    The ARN of the IAM role of the Amazon S3 bucket.
    bucketAccessRoleArn string
    The ARN of the IAM role of the Amazon S3 bucket.
    bucket_access_role_arn str
    The ARN of the IAM role of the Amazon S3 bucket.
    bucketAccessRoleArn String
    The ARN of the IAM role of the Amazon S3 bucket.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native