Class CfnLocationS3Props
Properties for defining a CfnLocationS3
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocationS3Props : Object, ICfnLocationS3Props
Syntax (vb)
Public Class CfnLocationS3Props
Inherits Object
Implements ICfnLocationS3Props
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html
ExampleMetadata: fixture=_generated
Examples
// 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 cfnLocationS3Props = new CfnLocationS3Props {
S3Config = new S3ConfigProperty {
BucketAccessRoleArn = "bucketAccessRoleArn"
},
// the properties below are optional
S3BucketArn = "s3BucketArn",
S3StorageClass = "s3StorageClass",
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnLocationS3Props() |
Properties
S3BucketArn | The ARN of the Amazon S3 bucket. |
S3Config | The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. |
S3StorageClass | The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. |
Subdirectory | Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location). |
Tags | Specifies labels that help you categorize, filter, and search for your AWS resources. |
Constructors
CfnLocationS3Props()
public CfnLocationS3Props()
Properties
S3BucketArn
The ARN of the Amazon S3 bucket.
public string S3BucketArn { get; set; }
Property Value
System.String
Remarks
S3Config
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
public object S3Config { get; set; }
Property Value
System.Object
Remarks
For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .
S3StorageClass
The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
public string S3StorageClass { get; set; }
Property Value
System.String
Remarks
For buckets in AWS Regions , the storage class defaults to S3 Standard.
For more information about S3 storage classes, see Amazon S3 Storage Classes . Some storage classes have behaviors that can affect your S3 storage costs. For detailed information, see Considerations When Working with Amazon S3 Storage Classes in DataSync .
Default: - "STANDARD"
Subdirectory
Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).
public string Subdirectory { get; set; }
Property Value
System.String
Remarks
DataSync can't transfer objects with a prefix that begins with a slash ( /
) or includes //
, /./
, or /../
patterns. For example:
Tags
Specifies labels that help you categorize, filter, and search for your AWS resources.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
We recommend creating at least a name tag for your transfer location.