Struct StartAssetBundleExportJobInput

#[non_exhaustive]
pub struct StartAssetBundleExportJobInput {
    pub aws_account_id: Option<String>,
    pub asset_bundle_export_job_id: Option<String>,
    pub resource_arns: Option<Vec<String>>,
    pub include_all_dependencies: Option<bool>,
    pub export_format: Option<AssetBundleExportFormat>,
    pub cloud_formation_override_property_configuration: Option<AssetBundleCloudFormationOverridePropertyConfiguration>,
    pub include_permissions: Option<bool>,
    pub include_tags: Option<bool>,
    pub validation_strategy: Option<AssetBundleExportJobValidationStrategy>,
    pub include_folder_memberships: Option<bool>,
    pub include_folder_members: Option<IncludeFolderMembers>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

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

asset_bundle_export_job_id: Option<String>

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.

resource_arns: Option<Vec<String>>

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.

include_all_dependencies: Option<bool>

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.

export_format: Option<AssetBundleExportFormat>

The export data format.

cloud_formation_override_property_configuration: Option<AssetBundleCloudFormationOverridePropertyConfiguration>

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.

include_permissions: Option<bool>

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.

include_tags: Option<bool>

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.

validation_strategy: Option<AssetBundleExportJobValidationStrategy>

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.

include_folder_memberships: Option<bool>

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

include_folder_members: Option<IncludeFolderMembers>

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

Implementations

impl StartAssetBundleExportJobInput

pub fn aws_account_id(&self) -> Option<&str>

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

pub fn asset_bundle_export_job_id(&self) -> Option<&str>

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.

pub fn resource_arns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_arns.is_none().

pub fn include_all_dependencies(&self) -> Option<bool>

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.

pub fn export_format(&self) -> Option<&AssetBundleExportFormat>

The export data format.

pub fn cloud_formation_override_property_configuration( &self, ) -> Option<&AssetBundleCloudFormationOverridePropertyConfiguration>

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.

pub fn include_permissions(&self) -> Option<bool>

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.

pub fn include_tags(&self) -> Option<bool>

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.

pub fn validation_strategy( &self, ) -> Option<&AssetBundleExportJobValidationStrategy>

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.

pub fn include_folder_memberships(&self) -> Option<bool>

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

pub fn include_folder_members(&self) -> Option<&IncludeFolderMembers>

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

impl StartAssetBundleExportJobInput

pub fn builder() -> StartAssetBundleExportJobInputBuilder

Creates a new builder-style object to manufacture StartAssetBundleExportJobInput.

Trait Implementations

impl Clone for StartAssetBundleExportJobInput

fn clone(&self) -> StartAssetBundleExportJobInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartAssetBundleExportJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartAssetBundleExportJobInput

fn eq(&self, other: &StartAssetBundleExportJobInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartAssetBundleExportJobInput