Class: AWSCDK::Datasync::CfnTask::ManifestConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
datasync/cfn_task.rb

Overview

Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.

For more information and configuration examples, see Specifying what DataSync transfers by using a manifest .

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source:, action: nil, format: nil) ⇒ ManifestConfigProperty

Returns a new instance of ManifestConfigProperty.

Parameters:

  • source (AWSCDK::IResolvable, AWSCDK::Datasync::CfnTask::SourceProperty)

    Specifies the manifest that you want DataSync to use and where it's hosted.

  • action (String, nil) (defaults to: nil)

    Specifies what DataSync uses the manifest for.

  • format (String, nil) (defaults to: nil)

    Specifies the file format of your manifest.



809
810
811
812
813
814
815
816
# File 'datasync/cfn_task.rb', line 809

def initialize(source:, action: nil, format: nil)
  @source = source.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::SourceProperty.new(**source.transform_keys(&:to_sym)) : source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLlNvdXJjZVByb3BlcnR5In1dfX0=")), "source")
  @action = action
  Jsii::Type.check_type(@action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "action") unless @action.nil?
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format") unless @format.nil?
end

Instance Attribute Details

#actionString? (readonly)

Specifies what DataSync uses the manifest for.



831
832
833
# File 'datasync/cfn_task.rb', line 831

def action
  @action
end

#formatString? (readonly)

Specifies the file format of your manifest.

For more information, see Creating a manifest .



838
839
840
# File 'datasync/cfn_task.rb', line 838

def format
  @format
end

#sourceAWSCDK::IResolvable, AWSCDK::Datasync::CfnTask::SourceProperty (readonly)

Specifies the manifest that you want DataSync to use and where it's hosted.

You must specify this parameter if you're configuring a new manifest on or after February 7, 2024.

If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest .



826
827
828
# File 'datasync/cfn_task.rb', line 826

def source
  @source
end

Class Method Details

.jsii_propertiesObject



840
841
842
843
844
845
846
# File 'datasync/cfn_task.rb', line 840

def self.jsii_properties
  {
    :source => "source",
    :action => "action",
    :format => "format",
  }
end

Instance Method Details

#to_jsiiObject



848
849
850
851
852
853
854
855
856
# File 'datasync/cfn_task.rb', line 848

def to_jsii
  result = {}
  result.merge!({
    "source" => @source,
    "action" => @action,
    "format" => @format,
  })
  result.compact
end