Struct aws_sdk_apigatewayv2::types::Stage
source · #[non_exhaustive]pub struct Stage {Show 14 fields
pub access_log_settings: Option<AccessLogSettings>,
pub api_gateway_managed: Option<bool>,
pub auto_deploy: Option<bool>,
pub client_certificate_id: Option<String>,
pub created_date: Option<DateTime>,
pub default_route_settings: Option<RouteSettings>,
pub deployment_id: Option<String>,
pub description: Option<String>,
pub last_deployment_status_message: Option<String>,
pub last_updated_date: Option<DateTime>,
pub route_settings: Option<HashMap<String, RouteSettings>>,
pub stage_name: Option<String>,
pub stage_variables: Option<HashMap<String, String>>,
pub tags: Option<HashMap<String, String>>,
}
Expand description
Represents an API stage.
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.access_log_settings: Option<AccessLogSettings>
Settings for logging access in this stage.
api_gateway_managed: Option<bool>
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
auto_deploy: Option<bool>
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id: Option<String>
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
created_date: Option<DateTime>
The timestamp when the stage was created.
default_route_settings: Option<RouteSettings>
Default route settings for the stage.
deployment_id: Option<String>
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
description: Option<String>
The description of the stage.
last_deployment_status_message: Option<String>
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
last_updated_date: Option<DateTime>
The timestamp when the stage was last updated.
route_settings: Option<HashMap<String, RouteSettings>>
Route settings for the stage, by routeKey.
stage_name: Option<String>
The name of the stage.
stage_variables: Option<HashMap<String, String>>
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
The collection of tags. Each tag element is associated with a given resource.
Implementations§
source§impl Stage
impl Stage
sourcepub fn access_log_settings(&self) -> Option<&AccessLogSettings>
pub fn access_log_settings(&self) -> Option<&AccessLogSettings>
Settings for logging access in this stage.
sourcepub fn api_gateway_managed(&self) -> Option<bool>
pub fn api_gateway_managed(&self) -> Option<bool>
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
sourcepub fn auto_deploy(&self) -> Option<bool>
pub fn auto_deploy(&self) -> Option<bool>
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
sourcepub fn client_certificate_id(&self) -> Option<&str>
pub fn client_certificate_id(&self) -> Option<&str>
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The timestamp when the stage was created.
sourcepub fn default_route_settings(&self) -> Option<&RouteSettings>
pub fn default_route_settings(&self) -> Option<&RouteSettings>
Default route settings for the stage.
sourcepub fn deployment_id(&self) -> Option<&str>
pub fn deployment_id(&self) -> Option<&str>
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the stage.
sourcepub fn last_deployment_status_message(&self) -> Option<&str>
pub fn last_deployment_status_message(&self) -> Option<&str>
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
sourcepub fn last_updated_date(&self) -> Option<&DateTime>
pub fn last_updated_date(&self) -> Option<&DateTime>
The timestamp when the stage was last updated.
sourcepub fn route_settings(&self) -> Option<&HashMap<String, RouteSettings>>
pub fn route_settings(&self) -> Option<&HashMap<String, RouteSettings>>
Route settings for the stage, by routeKey.
sourcepub fn stage_name(&self) -> Option<&str>
pub fn stage_name(&self) -> Option<&str>
The name of the stage.
sourcepub fn stage_variables(&self) -> Option<&HashMap<String, String>>
pub fn stage_variables(&self) -> Option<&HashMap<String, String>>
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
The collection of tags. Each tag element is associated with a given resource.
Trait Implementations§
source§impl PartialEq for Stage
impl PartialEq for Stage
impl StructuralPartialEq for Stage
Auto Trait Implementations§
impl Freeze for Stage
impl RefUnwindSafe for Stage
impl Send for Stage
impl Sync for Stage
impl Unpin for Stage
impl UnwindSafe for Stage
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> 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 more