Package software.amazon.awscdk.services.datasync

Class CfnLocationAzureBlob.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationAzureBlob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationAzureBlob>

Enclosing class:

CfnLocationAzureBlob

@Stability(Stable)
public static final class CfnLocationAzureBlob.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationAzureBlob>

A fluent builder for CfnLocationAzureBlob.

Method Summary

Modifier and Type	Method	Description
CfnLocationAzureBlob.Builder	agentArns(List<String> agentArns)	(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
CfnLocationAzureBlob.Builder	azureAccessTier(String azureAccessTier)	Specifies the access tier that you want your objects or files transferred into.
CfnLocationAzureBlob.Builder	azureBlobAuthenticationType(String azureBlobAuthenticationType)	Specifies the authentication method DataSync uses to access your Azure Blob Storage.
CfnLocationAzureBlob.Builder	azureBlobContainerUrl(String azureBlobContainerUrl)	Specifies the URL of the Azure Blob Storage container involved in your transfer.
CfnLocationAzureBlob.Builder	azureBlobSasConfiguration(IResolvable azureBlobSasConfiguration)	Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
CfnLocationAzureBlob.Builder	azureBlobSasConfiguration(CfnLocationAzureBlob.AzureBlobSasConfigurationProperty azureBlobSasConfiguration)	Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
CfnLocationAzureBlob.Builder	azureBlobType(String azureBlobType)	Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.
CfnLocationAzureBlob	build()
CfnLocationAzureBlob.Builder	cmkSecretConfig(IResolvable cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
CfnLocationAzureBlob.Builder	cmkSecretConfig(CfnLocationAzureBlob.CmkSecretConfigProperty cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
static CfnLocationAzureBlob.Builder	create(software.constructs.Construct scope, String id)
CfnLocationAzureBlob.Builder	customSecretConfig(IResolvable customSecretConfig)	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
CfnLocationAzureBlob.Builder	customSecretConfig(CfnLocationAzureBlob.CustomSecretConfigProperty customSecretConfig)	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
CfnLocationAzureBlob.Builder	subdirectory(String subdirectory)	Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).
CfnLocationAzureBlob.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLocationAzureBlob.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLocationAzureBlob.Builder.

azureBlobAuthenticationType

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureBlobAuthenticationType(String azureBlobAuthenticationType)

Specifies the authentication method DataSync uses to access your Azure Blob Storage.

DataSync can access blob storage using a shared access signature (SAS).

Default: - "SAS"

Parameters:

azureBlobAuthenticationType - Specifies the authentication method DataSync uses to access your Azure Blob Storage. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobauthenticationtype

agentArns

@Stability(Stable)
public CfnLocationAzureBlob.Builder agentArns(List<String> agentArns)

(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You can specify more than one agent. For more information, see Using multiple agents for your transfer .

Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

Parameters:

agentArns - (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-agentarns

azureAccessTier

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureAccessTier(String azureAccessTier)

Specifies the access tier that you want your objects or files transferred into.

This only applies when using the location as a transfer destination. For more information, see Access tiers .

Default: - "HOT"

Parameters:

azureAccessTier - Specifies the access tier that you want your objects or files transferred into. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureaccesstier

azureBlobContainerUrl

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureBlobContainerUrl(String azureBlobContainerUrl)

Specifies the URL of the Azure Blob Storage container involved in your transfer.

Parameters:

azureBlobContainerUrl - Specifies the URL of the Azure Blob Storage container involved in your transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobcontainerurl

azureBlobSasConfiguration

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureBlobSasConfiguration(IResolvable azureBlobSasConfiguration)

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

If you provide an authentication token using SasConfiguration , but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig , then DataSync stores the token using your AWS account's secrets manager secret.

Parameters:

azureBlobSasConfiguration - Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobsasconfiguration

azureBlobSasConfiguration

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureBlobSasConfiguration(CfnLocationAzureBlob.AzureBlobSasConfigurationProperty azureBlobSasConfiguration)

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

If you provide an authentication token using SasConfiguration , but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig , then DataSync stores the token using your AWS account's secrets manager secret.

Parameters:

azureBlobSasConfiguration - Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobsasconfiguration

azureBlobType

@Stability(Stable)
public CfnLocationAzureBlob.Builder azureBlobType(String azureBlobType)

Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.

Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation .

Default: - "BLOCK"

Parameters:

azureBlobType - Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobtype

cmkSecretConfig

@Stability(Stable)
public CfnLocationAzureBlob.Builder cmkSecretConfig(IResolvable cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-cmksecretconfig

cmkSecretConfig

@Stability(Stable)
public CfnLocationAzureBlob.Builder cmkSecretConfig(CfnLocationAzureBlob.CmkSecretConfigProperty cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-cmksecretconfig

customSecretConfig

@Stability(Stable)
public CfnLocationAzureBlob.Builder customSecretConfig(IResolvable customSecretConfig)

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-customsecretconfig

customSecretConfig

@Stability(Stable)
public CfnLocationAzureBlob.Builder customSecretConfig(CfnLocationAzureBlob.CustomSecretConfigProperty customSecretConfig)

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-customsecretconfig

subdirectory

@Stability(Stable)
public CfnLocationAzureBlob.Builder subdirectory(String subdirectory)

Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ).

Parameters:

subdirectory - Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-subdirectory

tags

@Stability(Stable)
public CfnLocationAzureBlob.Builder tags(List<? extends CfnTag> tags)

Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least a name tag for your transfer location.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-tags

build

@Stability(Stable)
public CfnLocationAzureBlob build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationAzureBlob>

Returns:

a newly built instance of CfnLocationAzureBlob.