pub struct CreateApiCacheFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateApiCache
.
Creates a cache for the GraphQL API.
Implementations§
Source§impl CreateApiCacheFluentBuilder
impl CreateApiCacheFluentBuilder
Sourcepub fn as_input(&self) -> &CreateApiCacheInputBuilder
pub fn as_input(&self) -> &CreateApiCacheInputBuilder
Access the CreateApiCache as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateApiCacheOutput, SdkError<CreateApiCacheError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateApiCacheOutput, SdkError<CreateApiCacheError, 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<CreateApiCacheOutput, CreateApiCacheError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateApiCacheOutput, CreateApiCacheError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_api_id(self, input: Option<String>) -> Self
pub fn set_api_id(self, input: Option<String>) -> Self
The GraphQL API ID.
Sourcepub fn get_api_id(&self) -> &Option<String>
pub fn get_api_id(&self) -> &Option<String>
The GraphQL API ID.
Sourcepub fn ttl(self, input: i64) -> Self
pub fn ttl(self, input: i64) -> Self
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
Sourcepub fn set_ttl(self, input: Option<i64>) -> Self
pub fn set_ttl(self, input: Option<i64>) -> Self
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
Sourcepub fn get_ttl(&self) -> &Option<i64>
pub fn get_ttl(&self) -> &Option<i64>
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
Sourcepub fn transit_encryption_enabled(self, input: bool) -> Self
👎Deprecated since 5/15/2025: transitEncryptionEnabled attribute is deprecated. Encryption in transit is always enabled.
pub fn transit_encryption_enabled(self, input: bool) -> Self
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
Sourcepub fn set_transit_encryption_enabled(self, input: Option<bool>) -> Self
👎Deprecated since 5/15/2025: transitEncryptionEnabled attribute is deprecated. Encryption in transit is always enabled.
pub fn set_transit_encryption_enabled(self, input: Option<bool>) -> Self
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
Sourcepub fn get_transit_encryption_enabled(&self) -> &Option<bool>
👎Deprecated since 5/15/2025: transitEncryptionEnabled attribute is deprecated. Encryption in transit is always enabled.
pub fn get_transit_encryption_enabled(&self) -> &Option<bool>
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
Sourcepub fn at_rest_encryption_enabled(self, input: bool) -> Self
👎Deprecated since 5/15/2025: atRestEncryptionEnabled attribute is deprecated. Encryption at rest is always enabled.
pub fn at_rest_encryption_enabled(self, input: bool) -> Self
At-rest encryption flag for cache. You cannot update this setting after creation.
Sourcepub fn set_at_rest_encryption_enabled(self, input: Option<bool>) -> Self
👎Deprecated since 5/15/2025: atRestEncryptionEnabled attribute is deprecated. Encryption at rest is always enabled.
pub fn set_at_rest_encryption_enabled(self, input: Option<bool>) -> Self
At-rest encryption flag for cache. You cannot update this setting after creation.
Sourcepub fn get_at_rest_encryption_enabled(&self) -> &Option<bool>
👎Deprecated since 5/15/2025: atRestEncryptionEnabled attribute is deprecated. Encryption at rest is always enabled.
pub fn get_at_rest_encryption_enabled(&self) -> &Option<bool>
At-rest encryption flag for cache. You cannot update this setting after creation.
Sourcepub fn api_caching_behavior(self, input: ApiCachingBehavior) -> Self
pub fn api_caching_behavior(self, input: ApiCachingBehavior) -> Self
Caching behavior.
-
FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.
Sourcepub fn set_api_caching_behavior(self, input: Option<ApiCachingBehavior>) -> Self
pub fn set_api_caching_behavior(self, input: Option<ApiCachingBehavior>) -> Self
Caching behavior.
-
FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.
Sourcepub fn get_api_caching_behavior(&self) -> &Option<ApiCachingBehavior>
pub fn get_api_caching_behavior(&self) -> &Option<ApiCachingBehavior>
Caching behavior.
-
FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.
Sourcepub fn type(self, input: ApiCacheType) -> Self
pub fn type(self, input: ApiCacheType) -> Self
The cache instance type. Valid values are
-
SMALL
-
MEDIUM
-
LARGE
-
XLARGE
-
LARGE_2X
-
LARGE_4X
-
LARGE_8X
(not available in all regions) -
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
-
T2_SMALL: A t2.small instance type.
-
T2_MEDIUM: A t2.medium instance type.
-
R4_LARGE: A r4.large instance type.
-
R4_XLARGE: A r4.xlarge instance type.
-
R4_2XLARGE: A r4.2xlarge instance type.
-
R4_4XLARGE: A r4.4xlarge instance type.
-
R4_8XLARGE: A r4.8xlarge instance type.
Sourcepub fn set_type(self, input: Option<ApiCacheType>) -> Self
pub fn set_type(self, input: Option<ApiCacheType>) -> Self
The cache instance type. Valid values are
-
SMALL
-
MEDIUM
-
LARGE
-
XLARGE
-
LARGE_2X
-
LARGE_4X
-
LARGE_8X
(not available in all regions) -
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
-
T2_SMALL: A t2.small instance type.
-
T2_MEDIUM: A t2.medium instance type.
-
R4_LARGE: A r4.large instance type.
-
R4_XLARGE: A r4.xlarge instance type.
-
R4_2XLARGE: A r4.2xlarge instance type.
-
R4_4XLARGE: A r4.4xlarge instance type.
-
R4_8XLARGE: A r4.8xlarge instance type.
Sourcepub fn get_type(&self) -> &Option<ApiCacheType>
pub fn get_type(&self) -> &Option<ApiCacheType>
The cache instance type. Valid values are
-
SMALL
-
MEDIUM
-
LARGE
-
XLARGE
-
LARGE_2X
-
LARGE_4X
-
LARGE_8X
(not available in all regions) -
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
-
T2_SMALL: A t2.small instance type.
-
T2_MEDIUM: A t2.medium instance type.
-
R4_LARGE: A r4.large instance type.
-
R4_XLARGE: A r4.xlarge instance type.
-
R4_2XLARGE: A r4.2xlarge instance type.
-
R4_4XLARGE: A r4.4xlarge instance type.
-
R4_8XLARGE: A r4.8xlarge instance type.
Sourcepub fn health_metrics_config(self, input: CacheHealthMetricsConfig) -> Self
pub fn health_metrics_config(self, input: CacheHealthMetricsConfig) -> Self
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
-
NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
-
EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to ENABLED
or DISABLED
.
Sourcepub fn set_health_metrics_config(
self,
input: Option<CacheHealthMetricsConfig>,
) -> Self
pub fn set_health_metrics_config( self, input: Option<CacheHealthMetricsConfig>, ) -> Self
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
-
NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
-
EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to ENABLED
or DISABLED
.
Sourcepub fn get_health_metrics_config(&self) -> &Option<CacheHealthMetricsConfig>
pub fn get_health_metrics_config(&self) -> &Option<CacheHealthMetricsConfig>
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
-
NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
-
EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to ENABLED
or DISABLED
.
Trait Implementations§
Source§impl Clone for CreateApiCacheFluentBuilder
impl Clone for CreateApiCacheFluentBuilder
Source§fn clone(&self) -> CreateApiCacheFluentBuilder
fn clone(&self) -> CreateApiCacheFluentBuilder
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 CreateApiCacheFluentBuilder
impl !RefUnwindSafe for CreateApiCacheFluentBuilder
impl Send for CreateApiCacheFluentBuilder
impl Sync for CreateApiCacheFluentBuilder
impl Unpin for CreateApiCacheFluentBuilder
impl !UnwindSafe for CreateApiCacheFluentBuilder
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);