Class CfnLocationObjectStorage
The AWS::DataSync::LocationObjectStorage
resource specifies an endpoint for a self-managed object storage bucket.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnLocationObjectStorage : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnLocationObjectStorage
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information about self-managed object storage locations, see Creating a Location for Object Storage .
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 {
AgentArns = new [] { "agentArns" },
// the properties below are optional
AccessKey = "accessKey",
BucketName = "bucketName",
SecretKey = "secretKey",
ServerCertificate = "serverCertificate",
ServerHostname = "serverHostname",
ServerPort = 123,
ServerProtocol = "serverProtocol",
Subdirectory = "subdirectory",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnLocationObjectStorage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLocationObjectStorage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnLocationObjectStorage(Construct, String, ICfnLocationObjectStorageProps) |
Properties
AccessKey | Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. |
AgentArns | Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location. |
AttrLocationArn | The Amazon Resource Name (ARN) of the specified object storage location. |
AttrLocationUri | The URI of the specified object storage 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 | |
SecretKey | Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. |
ServerCertificate | Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, |
ServerHostname | Specifies the domain name or IP address of the object storage server. |
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. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLocationObjectStorage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLocationObjectStorage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLocationObjectStorage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLocationObjectStorage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnLocationObjectStorage(Construct, String, ICfnLocationObjectStorageProps)
public CfnLocationObjectStorage(Construct scope, string id, ICfnLocationObjectStorageProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnLocationObjectStorageProps
Resource properties.
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
System.String
AgentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
public virtual string[] AgentArns { get; set; }
Property Value
System.String[]
AttrLocationArn
The Amazon Resource Name (ARN) of the specified object storage location.
public virtual string AttrLocationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LocationArn
AttrLocationUri
The URI of the specified object storage location.
public virtual string AttrLocationUri { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LocationUri
BucketName
Specifies the name of the object storage bucket involved in the transfer.
public virtual string BucketName { get; set; }
Property Value
System.String
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
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
System.String
ServerCertificate
Specifies a file with the certificates that are used to sign the object storage server's certificate (for example, file:///home/user/.ssh/storage_sys_certificate.pem
). The file you specify must include the following:.
public virtual string ServerCertificate { get; set; }
Property Value
System.String
ServerHostname
Specifies the domain name or IP address of the object storage server.
public virtual string ServerHostname { get; set; }
Property Value
System.String
ServerPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
public virtual Nullable<double> ServerPort { get; set; }
Property Value
System.Nullable<System.Double>
ServerProtocol
Specifies the protocol that your object storage server uses to communicate.
public virtual string ServerProtocol { get; set; }
Property Value
System.String
Subdirectory
Specifies the object prefix for your object storage server.
public virtual string Subdirectory { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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[]
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>