Skip to content
v2.278.0

ManifestConfigProperty Struct ​

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 .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const manifestConfigProperty: datasync.CfnTask.ManifestConfigProperty = {
  source: {
    s3: {
      bucketAccessRoleArn: 'bucketAccessRoleArn',
      manifestObjectPath: 'manifestObjectPath',
      manifestObjectVersionId: 'manifestObjectVersionId',
      s3BucketArn: 's3BucketArn',
    },
  },

  // the properties below are optional
  action: 'action',
  format: 'format',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

manifest_config_property = datasync.CfnTask.ManifestConfigProperty(
    source=datasync.CfnTask.SourceProperty(
        s3=datasync.CfnTask.ManifestConfigSourceS3Property(
            bucket_access_role_arn="bucketAccessRoleArn",
            manifest_object_path="manifestObjectPath",
            manifest_object_version_id="manifestObjectVersionId",
            s3_bucket_arn="s3BucketArn"
        )
    ),

    # the properties below are optional
    action="action",
    format="format"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.datasync.*;

ManifestConfigProperty manifestConfigProperty = ManifestConfigProperty.builder()
        .source(SourceProperty.builder()
                .s3(ManifestConfigSourceS3Property.builder()
                        .bucketAccessRoleArn("bucketAccessRoleArn")
                        .manifestObjectPath("manifestObjectPath")
                        .manifestObjectVersionId("manifestObjectVersionId")
                        .s3BucketArn("s3BucketArn")
                        .build())
                .build())

        // the properties below are optional
        .action("action")
        .format("format")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;

var manifestConfigProperty = new ManifestConfigProperty {
    Source = new SourceProperty {
        S3 = new ManifestConfigSourceS3Property {
            BucketAccessRoleArn = "bucketAccessRoleArn",
            ManifestObjectPath = "manifestObjectPath",
            ManifestObjectVersionId = "manifestObjectVersionId",
            S3BucketArn = "s3BucketArn"
        }
    },

    // the properties below are optional
    Action = "action",
    Format = "format"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

manifestConfigProperty := &ManifestConfigProperty{
	Source: &SourceProperty{
		S3: &ManifestConfigSourceS3Property{
			BucketAccessRoleArn: jsii.String("bucketAccessRoleArn"),
			ManifestObjectPath: jsii.String("manifestObjectPath"),
			ManifestObjectVersionId: jsii.String("manifestObjectVersionId"),
			S3BucketArn: jsii.String("s3BucketArn"),
		},
	},

	// the properties below are optional
	Action: jsii.String("action"),
	Format: jsii.String("format"),
}

Properties ​

actionoptionalstringactionoptionalstractionoptionalStringActionoptionalstringActionoptional*string #
Specifies what DataSync uses the manifest for.
formatoptionalstringformatoptionalstrformatoptionalStringFormatoptionalstringFormatoptional*string #
Specifies the file format of your manifest.

For more information, see Creating a manifest .

sourceIResolvable | CfnTask.SourcePropertysourcetyping.Union[IResolvable, SourceProperty]sourceIResolvableSourceIResolvableSourceinterface{} required #
Specifies the manifest that you want DataSync to use and where it's hosted.
notes

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 .