Struct aws_sdk_securityhub::types::AwsApiGatewayRestApiDetails

#[non_exhaustive]
pub struct AwsApiGatewayRestApiDetails {
    pub id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub created_date: Option<String>,
    pub version: Option<String>,
    pub binary_media_types: Option<Vec<String>>,
    pub minimum_compression_size: Option<i32>,
    pub api_key_source: Option<String>,
    pub endpoint_configuration: Option<AwsApiGatewayEndpointConfiguration>,
}

Contains information about a REST API in version 1 of 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.

id: Option<String>

The identifier of the REST API.

name: Option<String>

The name of the REST API.

description: Option<String>

A description of the REST API.

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)

version: Option<String>

The version identifier for the REST API.

binary_media_types: Option<Vec<String>>

The list of binary media types supported by the REST API.

minimum_compression_size: Option<i32>

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

api_key_source: Option<String>

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

endpoint_configuration: Option<AwsApiGatewayEndpointConfiguration>

The endpoint configuration of the REST API.

Implementations

impl AwsApiGatewayRestApiDetails

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

The identifier of the REST API.

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

The name of the REST API.

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

A description of the REST API.

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 version(&self) -> Option<&str>

The version identifier for the REST API.

pub fn binary_media_types(&self) -> &[String]

The list of binary media types supported by the REST API.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .binary_media_types.is_none().

pub fn minimum_compression_size(&self) -> Option<i32>

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

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

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

pub fn endpoint_configuration( &self ) -> Option<&AwsApiGatewayEndpointConfiguration>

The endpoint configuration of the REST API.

impl AwsApiGatewayRestApiDetails

pub fn builder() -> AwsApiGatewayRestApiDetailsBuilder

Creates a new builder-style object to manufacture AwsApiGatewayRestApiDetails.

Trait Implementations

impl Clone for AwsApiGatewayRestApiDetails

fn clone(&self) -> AwsApiGatewayRestApiDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AwsApiGatewayRestApiDetails

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

Formats the value using the given formatter.

impl PartialEq for AwsApiGatewayRestApiDetails

fn eq(&self, other: &AwsApiGatewayRestApiDetails) -> 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 AwsApiGatewayRestApiDetails