Class CfnLocationS3

The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnLocationS3

Implements

IInspectable

ILocationS3Ref

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLocationS3 : CfnResource, IInspectable, ILocationS3Ref, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnLocationS3 Inherits CfnResource Implements IInspectable, ILocationS3Ref, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

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 cfnLocationS3 = new CfnLocationS3(this, "MyCfnLocationS3", 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

CfnLocationS3(Construct, string, ICfnLocationS3Props)

Create a new AWS::DataSync::LocationS3.

Properties

AttrLocationArn	The Amazon Resource Name (ARN) of the specified Amazon S3 location.
AttrLocationUri	The URI of the specified Amazon S3 location.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::DataSync::LocationS3` resource specifies an endpoint for an Amazon S3 bucket.
LocationS3Ref	A reference to a LocationS3 resource.
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	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnLocationS3(object)	Checks whether the given object is a CfnLocationS3.
RenderProperties(IDictionary<string, object>)	The `AWS::DataSync::LocationS3` resource specifies an endpoint for an Amazon S3 bucket.

Constructors

CfnLocationS3(Construct, string, ICfnLocationS3Props)

Create a new AWS::DataSync::LocationS3.

public CfnLocationS3(Construct scope, string id, ICfnLocationS3Props props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnLocationS3Props: Resource properties.

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

Properties

AttrLocationArn

The Amazon Resource Name (ARN) of the specified Amazon S3 location.

public virtual string AttrLocationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified Amazon S3 location.

public virtual string AttrLocationUri { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationUri

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

LocationS3Ref

A reference to a LocationS3 resource.

public virtual ILocationS3Reference LocationS3Ref { get; }

Property Value

ILocationS3Reference

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

S3BucketArn

The ARN of the Amazon S3 bucket.

public virtual string? S3BucketArn { get; set; }

Property Value

string

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

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 virtual object S3Config { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLocationS3.IS3ConfigProperty

S3StorageClass

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.

public virtual string? S3StorageClass { get; set; }

Property Value

string

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

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 virtual string? Subdirectory { get; set; }

Property Value

string

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

TagsRaw

Specifies labels that help you categorize, filter, and search for your AWS resources.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

IsCfnLocationS3(object)

Checks whether the given object is a CfnLocationS3.

public static bool IsCfnLocationS3(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

For more information, see the AWS DataSync User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

CloudformationResource: AWS::DataSync::LocationS3

ExampleMetadata: fixture=_generated

Implements

IInspectable

ILocationS3Ref

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable