@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
204 lines (203 loc) • 8.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages a Microsoft Azure Blob Storage Location within AWS DataSync.
*
* > **NOTE:** The DataSync Agents must be available before creating this resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.datasync.LocationAzureBlob("example", {
* agentArns: [exampleAwsDatasyncAgent.arn],
* authenticationType: "SAS",
* containerUrl: "https://myaccount.blob.core.windows.net/mycontainer",
* sasConfiguration: {
* token: "sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_datasync_location_azure_blob` using the Amazon Resource Name (ARN). For example:
*
* ```sh
* $ pulumi import aws:datasync/locationAzureBlob:LocationAzureBlob example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567
* ```
*/
export declare class LocationAzureBlob extends pulumi.CustomResource {
/**
* Get an existing LocationAzureBlob 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?: LocationAzureBlobState, opts?: pulumi.CustomResourceOptions): LocationAzureBlob;
/**
* Returns true if the given object is an instance of LocationAzureBlob. 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 LocationAzureBlob;
/**
* The access tier that you want your objects or files transferred into. Valid values: `HOT`, `COOL` and `ARCHIVE`. Default: `HOT`.
*/
readonly accessTier: pulumi.Output<string | undefined>;
/**
* A list of DataSync Agent ARNs with which this location will be associated.
*/
readonly agentArns: pulumi.Output<string[]>;
/**
* Amazon Resource Name (ARN) of the DataSync Location.
*/
readonly arn: pulumi.Output<string>;
/**
* The authentication method DataSync uses to access your Azure Blob Storage. Valid values: `SAS`.
*/
readonly authenticationType: pulumi.Output<string>;
/**
* The type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Valid values: `BLOB`. Default: `BLOB`.
*/
readonly blobType: pulumi.Output<string | undefined>;
/**
* The URL of the Azure Blob Storage container involved in your transfer.
*/
readonly containerUrl: 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>;
/**
* The SAS configuration that allows DataSync to access your Azure Blob Storage. See configuration below.
*/
readonly sasConfiguration: pulumi.Output<outputs.datasync.LocationAzureBlobSasConfiguration | undefined>;
/**
* Path segments if you want to limit your transfer to a virtual directory in the container.
*/
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 LocationAzureBlob 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: LocationAzureBlobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LocationAzureBlob resources.
*/
export interface LocationAzureBlobState {
/**
* The access tier that you want your objects or files transferred into. Valid values: `HOT`, `COOL` and `ARCHIVE`. Default: `HOT`.
*/
accessTier?: pulumi.Input<string>;
/**
* A list of DataSync Agent ARNs with which this location will be associated.
*/
agentArns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Amazon Resource Name (ARN) of the DataSync Location.
*/
arn?: pulumi.Input<string>;
/**
* The authentication method DataSync uses to access your Azure Blob Storage. Valid values: `SAS`.
*/
authenticationType?: pulumi.Input<string>;
/**
* The type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Valid values: `BLOB`. Default: `BLOB`.
*/
blobType?: pulumi.Input<string>;
/**
* The URL of the Azure Blob Storage container involved in your transfer.
*/
containerUrl?: 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>;
/**
* The SAS configuration that allows DataSync to access your Azure Blob Storage. See configuration below.
*/
sasConfiguration?: pulumi.Input<inputs.datasync.LocationAzureBlobSasConfiguration>;
/**
* Path segments if you want to limit your transfer to a virtual directory in the container.
*/
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 LocationAzureBlob resource.
*/
export interface LocationAzureBlobArgs {
/**
* The access tier that you want your objects or files transferred into. Valid values: `HOT`, `COOL` and `ARCHIVE`. Default: `HOT`.
*/
accessTier?: pulumi.Input<string>;
/**
* A list of DataSync Agent ARNs with which this location will be associated.
*/
agentArns: pulumi.Input<pulumi.Input<string>[]>;
/**
* The authentication method DataSync uses to access your Azure Blob Storage. Valid values: `SAS`.
*/
authenticationType: pulumi.Input<string>;
/**
* The type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Valid values: `BLOB`. Default: `BLOB`.
*/
blobType?: pulumi.Input<string>;
/**
* The URL of the Azure Blob Storage container involved in your transfer.
*/
containerUrl: 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>;
/**
* The SAS configuration that allows DataSync to access your Azure Blob Storage. See configuration below.
*/
sasConfiguration?: pulumi.Input<inputs.datasync.LocationAzureBlobSasConfiguration>;
/**
* Path segments if you want to limit your transfer to a virtual directory in the container.
*/
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>;
}>;
}