Class CfnLocationS3

A CloudFormation AWS::DataSync::LocationS3.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnLocationS3

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public class CfnLocationS3 : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnLocationS3
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

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

For more information, see Create an Amazon S3 location in the AWS DataSync User Guide .

CloudformationResource: AWS::DataSync::LocationS3

Link: 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 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`.
CfnLocationS3(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnLocationS3(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

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
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	A subdirectory in the Amazon S3 bucket.
Tags	The key-value pair that represents the tag that you want to add to the location.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

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 System.String

scoped id of the resource.

props ICfnLocationS3Props

resource properties.

CfnLocationS3(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnLocationS3(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnLocationS3(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnLocationS3(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrLocationArn

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

public virtual string AttrLocationArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified Amazon S3 location.

public virtual string AttrLocationUri { get; }

Property Value

System.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

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

S3BucketArn

The ARN of the Amazon S3 bucket.

public virtual string S3BucketArn { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3bucketarn

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

System.Object

Remarks

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3config

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

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3storageclass

Subdirectory

A subdirectory in the Amazon S3 bucket.

public virtual string Subdirectory { get; set; }

Property Value

System.String

Remarks

This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-subdirectory

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.

RenderProperties(IDictionary<String, Object>)

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

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable