#[non_exhaustive]pub struct CreateLocationObjectStorageInput {
pub server_hostname: Option<String>,
pub server_port: Option<i32>,
pub server_protocol: Option<ObjectStorageServerProtocol>,
pub subdirectory: Option<String>,
pub bucket_name: Option<String>,
pub access_key: Option<String>,
pub secret_key: Option<String>,
pub agent_arns: Option<Vec<String>>,
pub tags: Option<Vec<TagListEntry>>,
pub server_certificate: Option<Blob>,
pub cmk_secret_config: Option<CmkSecretConfig>,
pub custom_secret_config: Option<CustomSecretConfig>,
}Expand description
CreateLocationObjectStorageRequest
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.server_hostname: Option<String>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
server_port: Option<i32>Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
server_protocol: Option<ObjectStorageServerProtocol>Specifies the protocol that your object storage server uses to communicate.
subdirectory: Option<String>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.
bucket_name: Option<String>Specifies the name of the object storage bucket involved in the transfer.
access_key: Option<String>Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
secret_key: Option<String>Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
agent_arns: Option<Vec<String>>(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.
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.
server_certificate: Option<Blob>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 example cat command creates an object_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 to HTTPS.
cmk_secret_config: Option<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 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 the SecretKey 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 (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.
custom_secret_config: Option<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. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.
Implementations§
Source§impl CreateLocationObjectStorageInput
impl CreateLocationObjectStorageInput
Sourcepub fn server_hostname(&self) -> Option<&str>
pub fn server_hostname(&self) -> Option<&str>
Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
Sourcepub fn server_port(&self) -> Option<i32>
pub fn server_port(&self) -> Option<i32>
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
Sourcepub fn server_protocol(&self) -> Option<&ObjectStorageServerProtocol>
pub fn server_protocol(&self) -> Option<&ObjectStorageServerProtocol>
Specifies the protocol that your object storage server uses to communicate.
Sourcepub fn subdirectory(&self) -> Option<&str>
pub fn subdirectory(&self) -> Option<&str>
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.
Sourcepub fn bucket_name(&self) -> Option<&str>
pub fn bucket_name(&self) -> Option<&str>
Specifies the name of the object storage bucket involved in the transfer.
Sourcepub fn access_key(&self) -> Option<&str>
pub fn access_key(&self) -> Option<&str>
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
Sourcepub fn secret_key(&self) -> Option<&str>
pub fn secret_key(&self) -> Option<&str>
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
Sourcepub fn agent_arns(&self) -> &[String]
pub fn agent_arns(&self) -> &[String]
(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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .agent_arns.is_none().
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Sourcepub fn server_certificate(&self) -> Option<&Blob>
pub fn server_certificate(&self) -> Option<&Blob>
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 example cat command creates an object_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 to HTTPS.
Sourcepub fn cmk_secret_config(&self) -> Option<&CmkSecretConfig>
pub fn cmk_secret_config(&self) -> Option<&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 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 the SecretKey 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 (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.
Sourcepub fn custom_secret_config(&self) -> Option<&CustomSecretConfig>
pub fn custom_secret_config(&self) -> Option<&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. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
You can use either CmkSecretConfig (with SecretKey) or CustomSecretConfig (without SecretKey) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.
Source§impl CreateLocationObjectStorageInput
impl CreateLocationObjectStorageInput
Sourcepub fn builder() -> CreateLocationObjectStorageInputBuilder
pub fn builder() -> CreateLocationObjectStorageInputBuilder
Creates a new builder-style object to manufacture CreateLocationObjectStorageInput.
Trait Implementations§
Source§impl Clone for CreateLocationObjectStorageInput
impl Clone for CreateLocationObjectStorageInput
Source§fn clone(&self) -> CreateLocationObjectStorageInput
fn clone(&self) -> CreateLocationObjectStorageInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for CreateLocationObjectStorageInput
impl PartialEq for CreateLocationObjectStorageInput
Source§fn eq(&self, other: &CreateLocationObjectStorageInput) -> bool
fn eq(&self, other: &CreateLocationObjectStorageInput) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for CreateLocationObjectStorageInput
Auto Trait Implementations§
impl Freeze for CreateLocationObjectStorageInput
impl RefUnwindSafe for CreateLocationObjectStorageInput
impl Send for CreateLocationObjectStorageInput
impl Sync for CreateLocationObjectStorageInput
impl Unpin for CreateLocationObjectStorageInput
impl UnwindSafe for CreateLocationObjectStorageInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);