Struct CreateApiInput

#[non_exhaustive]
pub struct CreateApiInput {

    pub api_key_selection_expression: Option<String>,
    pub cors_configuration: Option<Cors>,
    pub credentials_arn: Option<String>,
    pub description: Option<String>,
    pub disable_schema_validation: Option<bool>,
    pub disable_execute_api_endpoint: Option<bool>,
    pub ip_address_type: Option<IpAddressType>,
    pub name: Option<String>,
    pub protocol_type: Option<ProtocolType>,
    pub route_key: Option<String>,
    pub route_selection_expression: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub target: Option<String>,
    pub version: Option<String>,
}

Creates a new Api resource to represent an API.

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_key_selection_expression: Option<String>

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

cors_configuration: Option<Cors>

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

credentials_arn: Option<String>

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

description: Option<String>

The description of the API.

disable_schema_validation: Option<bool>

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

disable_execute_api_endpoint: Option<bool>

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

ip_address_type: Option<IpAddressType>

The IP address types that can invoke the API.

name: Option<String>

The name of the API.

protocol_type: Option<ProtocolType>

The API protocol.

route_key: Option<String>

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

route_selection_expression: Option<String>

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

tags: Option<HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

target: Option<String>

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

version: Option<String>

A version identifier for the API.

Implementations

impl CreateApiInput

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

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

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

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

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

The description of the API.

pub fn disable_schema_validation(&self) -> Option<bool>

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

pub fn disable_execute_api_endpoint(&self) -> Option<bool>

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

pub fn ip_address_type(&self) -> Option<&IpAddressType>

The IP address types that can invoke the API.

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

The name of the API.

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

The API protocol.

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

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

A version identifier for the API.

impl CreateApiInput

pub fn builder() -> CreateApiInputBuilder

Creates a new builder-style object to manufacture CreateApiInput.

Trait Implementations

impl Clone for CreateApiInput

fn clone(&self) -> CreateApiInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiInput

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

Formats the value using the given formatter.

impl PartialEq for CreateApiInput

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