Class CfnLocationObjectStorage

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnLocationObjectStorage

Implements

IInspectable

ILocationObjectStorageRef

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 CfnLocationObjectStorage : CfnResource, IInspectable, ILocationObjectStorageRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnLocationObjectStorage Inherits CfnResource Implements IInspectable, ILocationObjectStorageRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

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 cfnLocationObjectStorage = new CfnLocationObjectStorage(this, "MyCfnLocationObjectStorage", new CfnLocationObjectStorageProps {
                 AccessKey = "accessKey",
                 AgentArns = new [] { "agentArns" },
                 BucketName = "bucketName",
                 CmkSecretConfig = new CmkSecretConfigProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SecretArn = "secretArn"
                 },
                 CustomSecretConfig = new CustomSecretConfigProperty {
                     SecretAccessRoleArn = "secretAccessRoleArn",
                     SecretArn = "secretArn"
                 },
                 SecretKey = "secretKey",
                 ServerCertificate = "serverCertificate",
                 ServerHostname = "serverHostname",
                 ServerPort = 123,
                 ServerProtocol = "serverProtocol",
                 Subdirectory = "subdirectory",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnLocationObjectStorage(Construct, string, ICfnLocationObjectStorageProps?)

Create a new AWS::DataSync::LocationObjectStorage.

Properties

AccessKey	Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
AgentArns	(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
AttrCmkSecretConfigSecretArn	Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.
AttrLocationArn	The Amazon Resource Name (ARN) of the specified object storage location.
AttrLocationUri	The URI of the specified object storage location.
AttrManagedSecretConfig	Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.
BucketName	Specifies the name of the object storage bucket involved in the transfer.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket.
CmkSecretConfig	Specifies configuration information for a DataSync-managed secret, which includes the `SecretKey` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .
CustomSecretConfig	Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager.
LocationObjectStorageRef	A reference to a LocationObjectStorage resource.
SecretKey	Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
ServerCertificate	Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
ServerHostname	Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
ServerPort	Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
ServerProtocol	Specifies the protocol that your object storage server uses to communicate.
Subdirectory	Specifies the object prefix for your object storage server.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies the key-value pair that represents a tag that you want to add to the resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnLocationObjectStorage(object)	Checks whether the given object is a CfnLocationObjectStorage.
RenderProperties(IDictionary<string, object>)	The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket.

Constructors

CfnLocationObjectStorage(Construct, string, ICfnLocationObjectStorageProps?)

Create a new AWS::DataSync::LocationObjectStorage.

public CfnLocationObjectStorage(Construct scope, string id, ICfnLocationObjectStorageProps? props = null)

Parameters

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

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

Properties

AccessKey

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

public virtual string? AccessKey { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

AgentArns

(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

public virtual string[]? AgentArns { get; set; }

Property Value

string[]

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

AttrCmkSecretConfigSecretArn

Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

public virtual string AttrCmkSecretConfigSecretArn { get; }

Property Value

string

Remarks

This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

CloudformationAttribute: CmkSecretConfig.SecretArn

AttrLocationArn

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

public virtual string AttrLocationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified object storage location.

public virtual string AttrLocationUri { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationUri

AttrManagedSecretConfig

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

public virtual IResolvable AttrManagedSecretConfig { get; }

Property Value

IResolvable

Remarks

DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

CloudformationAttribute: ManagedSecretConfig

BucketName

Specifies the name of the object storage bucket involved in the transfer.

public virtual string? BucketName { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

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 about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

CmkSecretConfig

Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

public virtual object? CmkSecretConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLocationObjectStorage.ICmkSecretConfigProperty

CustomSecretConfig

Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager.

public virtual object? CustomSecretConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLocationObjectStorage.ICustomSecretConfigProperty

LocationObjectStorageRef

A reference to a LocationObjectStorage resource.

public virtual ILocationObjectStorageReference LocationObjectStorageRef { get; }

Property Value

ILocationObjectStorageReference

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

SecretKey

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

public virtual string? SecretKey { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

ServerCertificate

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

public virtual string? ServerCertificate { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

ServerHostname

Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

public virtual string? ServerHostname { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

ServerPort

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

public virtual double? ServerPort { get; set; }

Property Value

double?

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

ServerProtocol

Specifies the protocol that your object storage server uses to communicate.

public virtual string? ServerProtocol { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

Subdirectory

Specifies the object prefix for your object storage server.

public virtual string? Subdirectory { get; set; }

Property Value

string

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

TagsRaw

Specifies the key-value pair that represents a tag that you want to add to the resource.

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

Property Value

ICfnTag[]

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

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 about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

IsCfnLocationObjectStorage(object)

Checks whether the given object is a CfnLocationObjectStorage.

public static bool IsCfnLocationObjectStorage(object x)

Parameters

x object

Returns

bool

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.

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

Remarks

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

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

CloudformationResource: AWS::DataSync::LocationObjectStorage

ExampleMetadata: fixture=_generated

Implements

IInspectable

ILocationObjectStorageRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable