Class CfnLocationObjectStorageProps.Jsii$Proxy
- All Implemented Interfaces:
CfnLocationObjectStorageProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnLocationObjectStorageProps
CfnLocationObjectStorageProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.datasync.CfnLocationObjectStorageProps
CfnLocationObjectStorageProps.Builder, CfnLocationObjectStorageProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnLocationObjectStorageProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.final String
Specifies the name of the object storage bucket involved in the transfer.final Object
Specifies configuration information for a DataSync-managed secret, which includes theSecretKey
that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .final Object
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.final String
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.final String
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).final String
Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.final Number
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).final String
Specifies the protocol that your object storage server uses to communicate.final String
Specifies the object prefix for your object storage server.getTags()
Specifies the key-value pair that represents a tag that you want to add to the resource.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnLocationObjectStorageProps.Builder
.
-
-
Method Details
-
getAccessKey
Description copied from interface:CfnLocationObjectStorageProps
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.- Specified by:
getAccessKey
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getAgentArns
Description copied from interface:CfnLocationObjectStorageProps
(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
- Specified by:
getAgentArns
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getBucketName
Description copied from interface:CfnLocationObjectStorageProps
Specifies the name of the object storage bucket involved in the transfer.- Specified by:
getBucketName
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getCmkSecretConfig
Description copied from interface:CfnLocationObjectStorageProps
Specifies configuration information for a DataSync-managed secret, which includes theSecretKey
that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .When you include this paramater as part of a
CreateLocationObjectStorage
request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for theSecretKey
parameter to create a DataSync-managed secret to store the location access credentials.Make sure the DataSync has permission to access the KMS key that you specify.
You can use either
CmkSecretConfig
(withSecretKey
) orCustomSecretConfig
(withoutSecretKey
) to provide credentials for aCreateLocationObjectStorage
request. Do not provide both parameters for the same request.- Specified by:
getCmkSecretConfig
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getCustomSecretConfig
Description copied from interface:CfnLocationObjectStorageProps
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.This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
You can use either
CmkSecretConfig
(withSecretKey
) orCustomSecretConfig
(withoutSecretKey
) to provide credentials for aCreateLocationObjectStorage
request. Do not provide both parameters for the same request.- Specified by:
getCustomSecretConfig
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getSecretKey
Description copied from interface:CfnLocationObjectStorageProps
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.If you provide a secret using
SecretKey
, but do not provide secret configuration details usingCmkSecretConfig
orCustomSecretConfig
, then DataSync stores the token using your AWS account's Secrets Manager secret.- Specified by:
getSecretKey
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getServerCertificate
Description copied from interface:CfnLocationObjectStorageProps
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).You must specify a single
.pem
file with a full certificate chain (for example,file:///home/user/.ssh/object_storage_certificates.pem
).The certificate chain might include:
- The object storage system's certificate
- All intermediate certificates (if there are any)
- The root certificate of the signing CA
You can concatenate your certificates into a
.pem
file (which can be up to 32768 bytes before base64 encoding). The following examplecat
command creates anobject_storage_certificates.pem
file that includes three certificates:cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem
To use this parameter, configure
ServerProtocol
toHTTPS
.- Specified by:
getServerCertificate
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getServerHostname
Description copied from interface:CfnLocationObjectStorageProps
Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.- Specified by:
getServerHostname
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getServerPort
Description copied from interface:CfnLocationObjectStorageProps
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).- Specified by:
getServerPort
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getServerProtocol
Description copied from interface:CfnLocationObjectStorageProps
Specifies the protocol that your object storage server uses to communicate.If not specified, the default value is
HTTPS
.- Specified by:
getServerProtocol
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getSubdirectory
Description copied from interface:CfnLocationObjectStorageProps
Specifies the object prefix for your object storage server.If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
- Specified by:
getSubdirectory
in interfaceCfnLocationObjectStorageProps
- See Also:
-
getTags
Description copied from interface:CfnLocationObjectStorageProps
Specifies the key-value pair that represents a tag that you want to add to the resource.Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
- Specified by:
getTags
in interfaceCfnLocationObjectStorageProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-