Struct rusoto_apigatewayv2::CreateApiRequest
source · [−]pub struct CreateApiRequest {Show 13 fields
pub api_key_selection_expression: Option<String>,
pub cors_configuration: Option<Cors>,
pub credentials_arn: Option<String>,
pub description: Option<String>,
pub disable_execute_api_endpoint: Option<bool>,
pub disable_schema_validation: Option<bool>,
pub name: String,
pub protocol_type: String,
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>,
}
Expand description
Creates a new Api resource to represent an API.
Fields
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_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.
disable_schema_validation: Option<bool>
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
name: String
The name of the API.
protocol_type: String
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.
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.
Trait Implementations
sourceimpl Clone for CreateApiRequest
impl Clone for CreateApiRequest
sourcefn clone(&self) -> CreateApiRequest
fn clone(&self) -> CreateApiRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateApiRequest
impl Debug for CreateApiRequest
sourceimpl Default for CreateApiRequest
impl Default for CreateApiRequest
sourcefn default() -> CreateApiRequest
fn default() -> CreateApiRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<CreateApiRequest> for CreateApiRequest
impl PartialEq<CreateApiRequest> for CreateApiRequest
sourcefn eq(&self, other: &CreateApiRequest) -> bool
fn eq(&self, other: &CreateApiRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateApiRequest) -> bool
fn ne(&self, other: &CreateApiRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for CreateApiRequest
impl Serialize for CreateApiRequest
impl StructuralPartialEq for CreateApiRequest
Auto Trait Implementations
impl RefUnwindSafe for CreateApiRequest
impl Send for CreateApiRequest
impl Sync for CreateApiRequest
impl Unpin for CreateApiRequest
impl UnwindSafe for CreateApiRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more