Interface CreateLocationAzureBlobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLocationAzureBlobRequest.Builder,CreateLocationAzureBlobRequest>, DataSyncRequest.Builder, SdkBuilder<CreateLocationAzureBlobRequest.Builder,CreateLocationAzureBlobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLocationAzureBlobRequest
@Mutable @NotThreadSafe public static interface CreateLocationAzureBlobRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateLocationAzureBlobRequest.Builder,CreateLocationAzureBlobRequest>

  • Method Details

    • containerUrl

      CreateLocationAzureBlobRequest.Builder containerUrl(String containerUrl)

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

      Parameters:
      containerUrl - Specifies the URL of the Azure Blob Storage container involved in your transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationType

      CreateLocationAzureBlobRequest.Builder authenticationType(String authenticationType)

      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

      Parameters:
      authenticationType - Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationType

      CreateLocationAzureBlobRequest.Builder authenticationType(AzureBlobAuthenticationType authenticationType)

      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

      Parameters:
      authenticationType - Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sasConfiguration

      CreateLocationAzureBlobRequest.Builder sasConfiguration(AzureBlobSasConfiguration sasConfiguration)

      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 Amazon Web Services account's secrets manager secret.

      Parameters:
      sasConfiguration - 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 Amazon Web Services account's secrets manager secret.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sasConfiguration

      default CreateLocationAzureBlobRequest.Builder sasConfiguration(Consumer<AzureBlobSasConfiguration.Builder> sasConfiguration)

      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 Amazon Web Services account's secrets manager secret.

      This is a convenience method that creates an instance of the AzureBlobSasConfiguration.Builder avoiding the need to create one manually via AzureBlobSasConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sasConfiguration(AzureBlobSasConfiguration).

      Parameters:
      sasConfiguration - a consumer that will call methods on AzureBlobSasConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blobType

      CreateLocationAzureBlobRequest.Builder blobType(String blobType)

      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.

      Parameters:
      blobType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blobType

      CreateLocationAzureBlobRequest.Builder blobType(AzureBlobType blobType)

      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.

      Parameters:
      blobType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessTier

      CreateLocationAzureBlobRequest.Builder accessTier(String accessTier)

      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.

      Parameters:
      accessTier - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessTier

      CreateLocationAzureBlobRequest.Builder accessTier(AzureAccessTier accessTier)

      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.

      Parameters:
      accessTier - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subdirectory

      CreateLocationAzureBlobRequest.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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentArns

      CreateLocationAzureBlobRequest.Builder agentArns(Collection<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. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentArns

      CreateLocationAzureBlobRequest.Builder agentArns(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. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationAzureBlobRequest.Builder tags(Collection<TagListEntry> tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services 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 Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationAzureBlobRequest.Builder tags(TagListEntry... tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services 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 Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationAzureBlobRequest.Builder tags(Consumer<TagListEntry.Builder>... tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cmkSecretConfig

      CreateLocationAzureBlobRequest.Builder cmkSecretConfig(CmkSecretConfig cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the authentication token that DataSync uses to access a specific AzureBlob storage location, with a customer-managed KMS key.

      When you include this paramater as part of a CreateLocationAzureBlob request, you provide only the KMS key ARN. DataSync uses this KMS key together with the authentication token you specify for SasConfiguration to create a DataSync-managed secret to store the location access credentials.

      Make sure the DataSync has permission to access the KMS key that you specify.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Parameters:
      cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, which includes the authentication token that DataSync uses to access a specific AzureBlob storage location, with a customer-managed KMS key.

      When you include this paramater as part of a CreateLocationAzureBlob request, you provide only the KMS key ARN. DataSync uses this KMS key together with the authentication token you specify for SasConfiguration to create a DataSync-managed secret to store the location access credentials.

      Make sure the DataSync has permission to access the KMS key that you specify.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cmkSecretConfig

      default CreateLocationAzureBlobRequest.Builder cmkSecretConfig(Consumer<CmkSecretConfig.Builder> cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the authentication token that DataSync uses to access a specific AzureBlob storage location, with a customer-managed KMS key.

      When you include this paramater as part of a CreateLocationAzureBlob request, you provide only the KMS key ARN. DataSync uses this KMS key together with the authentication token you specify for SasConfiguration to create a DataSync-managed secret to store the location access credentials.

      Make sure the DataSync has permission to access the KMS key that you specify.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CmkSecretConfig.Builder avoiding the need to create one manually via CmkSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cmkSecretConfig(CmkSecretConfig).

      Parameters:
      cmkSecretConfig - a consumer that will call methods on CmkSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customSecretConfig

      CreateLocationAzureBlobRequest.Builder customSecretConfig(CustomSecretConfig customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the authentication token for an AzureBlob storage location 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 (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Parameters:
      customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where the authentication token for an AzureBlob storage location 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 (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customSecretConfig

      default CreateLocationAzureBlobRequest.Builder customSecretConfig(Consumer<CustomSecretConfig.Builder> customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the authentication token for an AzureBlob storage location 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 (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CustomSecretConfig.Builder avoiding the need to create one manually via CustomSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customSecretConfig(CustomSecretConfig).

      Parameters:
      customSecretConfig - a consumer that will call methods on CustomSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLocationAzureBlobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLocationAzureBlobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.