#[non_exhaustive]pub struct UpdateConnectorInputBuilder { /* private fields */ }
Expand description
A builder for UpdateConnectorInput
.
Implementations§
Source§impl UpdateConnectorInputBuilder
impl UpdateConnectorInputBuilder
Sourcepub fn connector_id(self, input: impl Into<String>) -> Self
pub fn connector_id(self, input: impl Into<String>) -> Self
The unique identifier for the connector.
This field is required.Sourcepub fn set_connector_id(self, input: Option<String>) -> Self
pub fn set_connector_id(self, input: Option<String>) -> Self
The unique identifier for the connector.
Sourcepub fn get_connector_id(&self) -> &Option<String>
pub fn get_connector_id(&self) -> &Option<String>
The unique identifier for the connector.
Sourcepub fn url(self, input: impl Into<String>) -> Self
pub fn url(self, input: impl Into<String>) -> Self
The URL of the partner's AS2 or SFTP endpoint.
Sourcepub fn set_url(self, input: Option<String>) -> Self
pub fn set_url(self, input: Option<String>) -> Self
The URL of the partner's AS2 or SFTP endpoint.
Sourcepub fn as2_config(self, input: As2ConnectorConfig) -> Self
pub fn as2_config(self, input: As2ConnectorConfig) -> Self
A structure that contains the parameters for an AS2 connector object.
Sourcepub fn set_as2_config(self, input: Option<As2ConnectorConfig>) -> Self
pub fn set_as2_config(self, input: Option<As2ConnectorConfig>) -> Self
A structure that contains the parameters for an AS2 connector object.
Sourcepub fn get_as2_config(&self) -> &Option<As2ConnectorConfig>
pub fn get_as2_config(&self) -> &Option<As2ConnectorConfig>
A structure that contains the parameters for an AS2 connector object.
Sourcepub fn access_role(self, input: impl Into<String>) -> Self
pub fn access_role(self, input: impl Into<String>) -> Self
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
For AS2 connectors
With AS2, you can send files by calling StartFileTransfer
and specifying the file paths in the request parameter, SendFilePaths
. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent directory is /bucket/dir/
) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt
permission for that key.
For SFTP connectors
Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer
request. Additionally, make sure that the role provides secretsmanager:GetSecretValue
permission to Secrets Manager.
Sourcepub fn set_access_role(self, input: Option<String>) -> Self
pub fn set_access_role(self, input: Option<String>) -> Self
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
For AS2 connectors
With AS2, you can send files by calling StartFileTransfer
and specifying the file paths in the request parameter, SendFilePaths
. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent directory is /bucket/dir/
) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt
permission for that key.
For SFTP connectors
Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer
request. Additionally, make sure that the role provides secretsmanager:GetSecretValue
permission to Secrets Manager.
Sourcepub fn get_access_role(&self) -> &Option<String>
pub fn get_access_role(&self) -> &Option<String>
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
For AS2 connectors
With AS2, you can send files by calling StartFileTransfer
and specifying the file paths in the request parameter, SendFilePaths
. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent directory is /bucket/dir/
) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt
permission for that key.
For SFTP connectors
Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer
request. Additionally, make sure that the role provides secretsmanager:GetSecretValue
permission to Secrets Manager.
Sourcepub fn logging_role(self, input: impl Into<String>) -> Self
pub fn logging_role(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
Sourcepub fn set_logging_role(self, input: Option<String>) -> Self
pub fn set_logging_role(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
Sourcepub fn get_logging_role(&self) -> &Option<String>
pub fn get_logging_role(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
Sourcepub fn sftp_config(self, input: SftpConnectorConfig) -> Self
pub fn sftp_config(self, input: SftpConnectorConfig) -> Self
A structure that contains the parameters for an SFTP connector object.
Sourcepub fn set_sftp_config(self, input: Option<SftpConnectorConfig>) -> Self
pub fn set_sftp_config(self, input: Option<SftpConnectorConfig>) -> Self
A structure that contains the parameters for an SFTP connector object.
Sourcepub fn get_sftp_config(&self) -> &Option<SftpConnectorConfig>
pub fn get_sftp_config(&self) -> &Option<SftpConnectorConfig>
A structure that contains the parameters for an SFTP connector object.
Sourcepub fn security_policy_name(self, input: impl Into<String>) -> Self
pub fn security_policy_name(self, input: impl Into<String>) -> Self
Specifies the name of the security policy for the connector.
Sourcepub fn set_security_policy_name(self, input: Option<String>) -> Self
pub fn set_security_policy_name(self, input: Option<String>) -> Self
Specifies the name of the security policy for the connector.
Sourcepub fn get_security_policy_name(&self) -> &Option<String>
pub fn get_security_policy_name(&self) -> &Option<String>
Specifies the name of the security policy for the connector.
Sourcepub fn build(self) -> Result<UpdateConnectorInput, BuildError>
pub fn build(self) -> Result<UpdateConnectorInput, BuildError>
Consumes the builder and constructs a UpdateConnectorInput
.
Source§impl UpdateConnectorInputBuilder
impl UpdateConnectorInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<UpdateConnectorOutput, SdkError<UpdateConnectorError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<UpdateConnectorOutput, SdkError<UpdateConnectorError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for UpdateConnectorInputBuilder
impl Clone for UpdateConnectorInputBuilder
Source§fn clone(&self) -> UpdateConnectorInputBuilder
fn clone(&self) -> UpdateConnectorInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UpdateConnectorInputBuilder
impl Debug for UpdateConnectorInputBuilder
Source§impl Default for UpdateConnectorInputBuilder
impl Default for UpdateConnectorInputBuilder
Source§fn default() -> UpdateConnectorInputBuilder
fn default() -> UpdateConnectorInputBuilder
impl StructuralPartialEq for UpdateConnectorInputBuilder
Auto Trait Implementations§
impl Freeze for UpdateConnectorInputBuilder
impl RefUnwindSafe for UpdateConnectorInputBuilder
impl Send for UpdateConnectorInputBuilder
impl Sync for UpdateConnectorInputBuilder
impl Unpin for UpdateConnectorInputBuilder
impl UnwindSafe for UpdateConnectorInputBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);