Struct CreateBasePathMappingInput

#[non_exhaustive]
pub struct CreateBasePathMappingInput {
    pub domain_name: Option<String>,
    pub base_path: Option<String>,
    pub rest_api_id: Option<String>,
    pub stage: Option<String>,
}

Requests API Gateway to create a new BasePathMapping resource.

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.

domain_name: Option<String>

The domain name of the BasePathMapping resource to create.

base_path: Option<String>

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

stage: Option<String>

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

Implementations

impl CreateBasePathMappingInput

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

The domain name of the BasePathMapping resource to create.

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

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

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

The string identifier of the associated RestApi.

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

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

impl CreateBasePathMappingInput

pub fn builder() -> CreateBasePathMappingInputBuilder

Creates a new builder-style object to manufacture CreateBasePathMappingInput.

Trait Implementations

impl Clone for CreateBasePathMappingInput

fn clone(&self) -> CreateBasePathMappingInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBasePathMappingInput

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

Formats the value using the given formatter.

impl PartialEq for CreateBasePathMappingInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateBasePathMappingInput