@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
196 lines (195 loc) • 8.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages an S3 Location within AWS DataSync.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.datasync.S3Location("example", {
* s3BucketArn: exampleAwsS3Bucket.arn,
* subdirectory: "/example/prefix",
* s3Config: {
* bucketAccessRoleArn: exampleAwsIamRole.arn,
* },
* });
* ```
*
* ### S3 Bucket on AWS Outposts
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const destination = new aws.datasync.S3Location("destination", {
* agentArns: [exampleAwsDatasyncAgent.arn],
* s3BucketArn: exampleAwsS3AccessPoint.arn,
* s3StorageClass: "OUTPOSTS",
* subdirectory: "/example/prefix",
* s3Config: {
* bucketAccessRoleArn: example.arn,
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_datasync_location_s3` using the DataSync Task Amazon Resource Name (ARN). For example:
*
* ```sh
* $ pulumi import aws:datasync/s3Location:S3Location example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567
* ```
*/
export declare class S3Location extends pulumi.CustomResource {
/**
* Get an existing S3Location 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?: S3LocationState, opts?: pulumi.CustomResourceOptions): S3Location;
/**
* Returns true if the given object is an instance of S3Location. 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 S3Location;
/**
* (Amazon S3 on Outposts only) Amazon Resource Name (ARN) of the DataSync agent on the Outpost.
*/
readonly agentArns: pulumi.Output<string[] | undefined>;
/**
* Amazon Resource Name (ARN) of the DataSync Location.
*/
readonly arn: pulumi.Output<string>;
/**
* 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>;
/**
* Amazon Resource Name (ARN) of the S3 bucket, or the Amazon S3 access point if the S3 bucket is located on an AWS Outposts resource.
*/
readonly s3BucketArn: pulumi.Output<string>;
/**
* Configuration block containing information for connecting to S3.
*/
readonly s3Config: pulumi.Output<outputs.datasync.S3LocationS3Config>;
/**
* Amazon S3 storage class that you want to store your files in when this location is used as a task destination. [Valid values](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
*/
readonly s3StorageClass: pulumi.Output<string>;
/**
* Prefix to perform actions as source or destination.
*/
readonly subdirectory: pulumi.Output<string>;
/**
* Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly uri: pulumi.Output<string>;
/**
* Create a S3Location 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: S3LocationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering S3Location resources.
*/
export interface S3LocationState {
/**
* (Amazon S3 on Outposts only) Amazon Resource Name (ARN) of the DataSync agent on the Outpost.
*/
agentArns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Amazon Resource Name (ARN) of the DataSync Location.
*/
arn?: pulumi.Input<string>;
/**
* 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>;
/**
* Amazon Resource Name (ARN) of the S3 bucket, or the Amazon S3 access point if the S3 bucket is located on an AWS Outposts resource.
*/
s3BucketArn?: pulumi.Input<string>;
/**
* Configuration block containing information for connecting to S3.
*/
s3Config?: pulumi.Input<inputs.datasync.S3LocationS3Config>;
/**
* Amazon S3 storage class that you want to store your files in when this location is used as a task destination. [Valid values](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
*/
s3StorageClass?: pulumi.Input<string>;
/**
* Prefix to perform actions as source or destination.
*/
subdirectory?: pulumi.Input<string>;
/**
* Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
uri?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a S3Location resource.
*/
export interface S3LocationArgs {
/**
* (Amazon S3 on Outposts only) Amazon Resource Name (ARN) of the DataSync agent on the Outpost.
*/
agentArns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 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>;
/**
* Amazon Resource Name (ARN) of the S3 bucket, or the Amazon S3 access point if the S3 bucket is located on an AWS Outposts resource.
*/
s3BucketArn: pulumi.Input<string>;
/**
* Configuration block containing information for connecting to S3.
*/
s3Config: pulumi.Input<inputs.datasync.S3LocationS3Config>;
/**
* Amazon S3 storage class that you want to store your files in when this location is used as a task destination. [Valid values](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
*/
s3StorageClass?: pulumi.Input<string>;
/**
* Prefix to perform actions as source or destination.
*/
subdirectory: pulumi.Input<string>;
/**
* Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}