Struct aws_sdk_securityhub::types::AwsApiGatewayV2ApiDetails

#[non_exhaustive]
pub struct AwsApiGatewayV2ApiDetails {
    pub api_endpoint: Option<String>,
    pub api_id: Option<String>,
    pub api_key_selection_expression: Option<String>,
    pub created_date: Option<String>,
    pub description: Option<String>,
    pub version: Option<String>,
    pub name: Option<String>,
    pub protocol_type: Option<String>,
    pub route_selection_expression: Option<String>,
    pub cors_configuration: Option<AwsCorsConfiguration>,
}

Contains information about a version 2 API in Amazon API Gateway.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

api_endpoint: Option<String>

The URI of the API.

Uses the format .execute-api..amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

api_id: Option<String>

The identifier of the API.

api_key_selection_expression: Option<String>

An API key selection expression. Supported only for WebSocket APIs.

created_date: Option<String>

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

description: Option<String>

A description of the API.

version: Option<String>

The version identifier for the API.

name: Option<String>

The name of the API.

protocol_type: Option<String>

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

route_selection_expression: Option<String>

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

cors_configuration: Option<AwsCorsConfiguration>

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

Implementations

impl AwsApiGatewayV2ApiDetails

pub fn api_endpoint(&self) -> Option<&str>

The URI of the API.

Uses the format .execute-api..amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

pub fn api_id(&self) -> Option<&str>

The identifier of the API.

pub fn api_key_selection_expression(&self) -> Option<&str>

An API key selection expression. Supported only for WebSocket APIs.

pub fn created_date(&self) -> Option<&str>

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

pub fn description(&self) -> Option<&str>

A description of the API.

pub fn version(&self) -> Option<&str>

The version identifier for the API.

pub fn name(&self) -> Option<&str>

The name of the API.

pub fn protocol_type(&self) -> Option<&str>

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

pub fn route_selection_expression(&self) -> Option<&str>

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

pub fn cors_configuration(&self) -> Option<&AwsCorsConfiguration>

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

impl AwsApiGatewayV2ApiDetails

pub fn builder() -> AwsApiGatewayV2ApiDetailsBuilder

Creates a new builder-style object to manufacture AwsApiGatewayV2ApiDetails.

Trait Implementations

impl Clone for AwsApiGatewayV2ApiDetails

fn clone(&self) -> AwsApiGatewayV2ApiDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AwsApiGatewayV2ApiDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AwsApiGatewayV2ApiDetails

fn eq(&self, other: &AwsApiGatewayV2ApiDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AwsApiGatewayV2ApiDetails