pub struct CreateConnectionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateConnection
.
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.
Implementations§
Source§impl CreateConnectionFluentBuilder
impl CreateConnectionFluentBuilder
Sourcepub fn as_input(&self) -> &CreateConnectionInputBuilder
pub fn as_input(&self) -> &CreateConnectionInputBuilder
Access the CreateConnection as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateConnectionOutput, SdkError<CreateConnectionError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateConnectionOutput, SdkError<CreateConnectionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateConnectionOutput, CreateConnectionError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateConnectionOutput, CreateConnectionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the connection to create.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the connection to create.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the connection to create.
The type of authorization to use for the connection.
OAUTH tokens are refreshed when a 401 or 407 response is returned.
The type of authorization to use for the connection.
OAUTH tokens are refreshed when a 401 or 407 response is returned.
The type of authorization to use for the connection.
OAUTH tokens are refreshed when a 401 or 407 response is returned.
Sourcepub fn auth_parameters(
self,
input: CreateConnectionAuthRequestParameters,
) -> Self
pub fn auth_parameters( self, input: CreateConnectionAuthRequestParameters, ) -> Self
The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the AuthorizationType
you specify.
Sourcepub fn set_auth_parameters(
self,
input: Option<CreateConnectionAuthRequestParameters>,
) -> Self
pub fn set_auth_parameters( self, input: Option<CreateConnectionAuthRequestParameters>, ) -> Self
The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the AuthorizationType
you specify.
Sourcepub fn get_auth_parameters(
&self,
) -> &Option<CreateConnectionAuthRequestParameters>
pub fn get_auth_parameters( &self, ) -> &Option<CreateConnectionAuthRequestParameters>
The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the AuthorizationType
you specify.
Sourcepub fn invocation_connectivity_parameters(
self,
input: ConnectivityResourceParameters,
) -> Self
pub fn invocation_connectivity_parameters( self, input: ConnectivityResourceParameters, ) -> Self
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
Sourcepub fn set_invocation_connectivity_parameters(
self,
input: Option<ConnectivityResourceParameters>,
) -> Self
pub fn set_invocation_connectivity_parameters( self, input: Option<ConnectivityResourceParameters>, ) -> Self
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
Sourcepub fn get_invocation_connectivity_parameters(
&self,
) -> &Option<ConnectivityResourceParameters>
pub fn get_invocation_connectivity_parameters( &self, ) -> &Option<ConnectivityResourceParameters>
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
Sourcepub fn kms_key_identifier(self, input: impl Into<String>) -> Self
pub fn kms_key_identifier(self, input: impl Into<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
Sourcepub fn set_kms_key_identifier(self, input: Option<String>) -> Self
pub fn set_kms_key_identifier(self, input: Option<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
Sourcepub fn get_kms_key_identifier(&self) -> &Option<String>
pub fn get_kms_key_identifier(&self) -> &Option<String>
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
Trait Implementations§
Source§impl Clone for CreateConnectionFluentBuilder
impl Clone for CreateConnectionFluentBuilder
Source§fn clone(&self) -> CreateConnectionFluentBuilder
fn clone(&self) -> CreateConnectionFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateConnectionFluentBuilder
impl !RefUnwindSafe for CreateConnectionFluentBuilder
impl Send for CreateConnectionFluentBuilder
impl Sync for CreateConnectionFluentBuilder
impl Unpin for CreateConnectionFluentBuilder
impl !UnwindSafe for CreateConnectionFluentBuilder
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);