Package software.amazon.awssdk.services.quicksight.model

Interface StartAssetBundleExportJobRequest.Builder

    • Method Detail

      • awsAccountId

        StartAssetBundleExportJobRequest.Builder awsAccountId​(String awsAccountId)

        The ID of the Amazon Web Services account to export assets from.

        Parameters:
        awsAccountId - The ID of the Amazon Web Services account to export assets from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetBundleExportJobId

        StartAssetBundleExportJobRequest.Builder assetBundleExportJobId​(String assetBundleExportJobId)

        The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

        Parameters:
        assetBundleExportJobId - The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceArns

        StartAssetBundleExportJobRequest.Builder resourceArns​(Collection<String> resourceArns)

        An array of resource ARNs to export. The following resources are supported.

        • Analysis

        • Dashboard

        • DataSet

        • DataSource

        • RefreshSchedule

        • Theme

        • VPCConnection

        The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

        Parameters:
        resourceArns - An array of resource ARNs to export. The following resources are supported.

        • Analysis

        • Dashboard

        • DataSet

        • DataSource

        • RefreshSchedule

        • Theme

        • VPCConnection

        The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

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

      • resourceArns

        StartAssetBundleExportJobRequest.Builder resourceArns​(String... resourceArns)

        An array of resource ARNs to export. The following resources are supported.

        • Analysis

        • Dashboard

        • DataSet

        • DataSource

        • RefreshSchedule

        • Theme

        • VPCConnection

        The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

        Parameters:
        resourceArns - An array of resource ARNs to export. The following resources are supported.

        • Analysis

        • Dashboard

        • DataSet

        • DataSource

        • RefreshSchedule

        • Theme

        • VPCConnection

        The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

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

      • includeAllDependencies

        StartAssetBundleExportJobRequest.Builder includeAllDependencies​(Boolean includeAllDependencies)

        A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

        Parameters:
        includeAllDependencies - A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudFormationOverridePropertyConfiguration

        StartAssetBundleExportJobRequest.Builder cloudFormationOverridePropertyConfiguration​(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration)

        An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

        Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

        Parameters:
        cloudFormationOverridePropertyConfiguration - An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

        Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

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

      • includePermissions

        StartAssetBundleExportJobRequest.Builder includePermissions​(Boolean includePermissions)

        A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

        Parameters:
        includePermissions - A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeTags

        StartAssetBundleExportJobRequest.Builder includeTags​(Boolean includeTags)

        A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

        Parameters:
        includeTags - A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validationStrategy

        StartAssetBundleExportJobRequest.Builder validationStrategy​(AssetBundleExportJobValidationStrategy validationStrategy)

        An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

        Parameters:
        validationStrategy - An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.