Struct GetMethodOutputBuilder

#[non_exhaustive]
pub struct GetMethodOutputBuilder { /* private fields */ }

A builder for GetMethodOutput.

Implementations

impl GetMethodOutputBuilder

pub fn http_method(self, input: impl Into<String>) -> Self

The method's HTTP verb.

pub fn set_http_method(self, input: Option<String>) -> Self

The method's HTTP verb.

pub fn get_http_method(&self) -> &Option<String>

The method's HTTP verb.

pub fn authorization_type(self, input: impl Into<String>) -> Self

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

pub fn set_authorization_type(self, input: Option<String>) -> Self

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

pub fn get_authorization_type(&self) -> &Option<String>

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

pub fn authorizer_id(self, input: impl Into<String>) -> Self

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

pub fn set_authorizer_id(self, input: Option<String>) -> Self

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

pub fn get_authorizer_id(&self) -> &Option<String>

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

pub fn api_key_required(self, input: bool) -> Self

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

pub fn set_api_key_required(self, input: Option<bool>) -> Self

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

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

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

pub fn request_validator_id(self, input: impl Into<String>) -> Self

The identifier of a RequestValidator for request validation.

pub fn set_request_validator_id(self, input: Option<String>) -> Self

The identifier of a RequestValidator for request validation.

pub fn get_request_validator_id(&self) -> &Option<String>

The identifier of a RequestValidator for request validation.

pub fn operation_name(self, input: impl Into<String>) -> Self

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

pub fn set_operation_name(self, input: Option<String>) -> Self

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

pub fn get_operation_name(&self) -> &Option<String>

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

pub fn request_parameters(self, k: impl Into<String>, v: bool) -> Self

Adds a key-value pair to request_parameters.

To override the contents of this collection use set_request_parameters.

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

pub fn set_request_parameters( self, input: Option<HashMap<String, bool>>, ) -> Self

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

pub fn request_models(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to request_models.

To override the contents of this collection use set_request_models.

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

pub fn set_request_models(self, input: Option<HashMap<String, String>>) -> Self

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

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

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

pub fn method_responses(self, k: impl Into<String>, v: MethodResponse) -> Self

Adds a key-value pair to method_responses.

To override the contents of this collection use set_method_responses.

Gets a method response associated with a given HTTP status code.

pub fn set_method_responses( self, input: Option<HashMap<String, MethodResponse>>, ) -> Self

Gets a method response associated with a given HTTP status code.

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

Gets a method response associated with a given HTTP status code.

pub fn method_integration(self, input: Integration) -> Self

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

pub fn set_method_integration(self, input: Option<Integration>) -> Self

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

pub fn get_method_integration(&self) -> &Option<Integration>

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

pub fn authorization_scopes(self, input: impl Into<String>) -> Self

Appends an item to authorization_scopes.

To override the contents of this collection use set_authorization_scopes.

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

pub fn set_authorization_scopes(self, input: Option<Vec<String>>) -> Self

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

pub fn get_authorization_scopes(&self) -> &Option<Vec<String>>

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

pub fn build(self) -> GetMethodOutput

Consumes the builder and constructs a GetMethodOutput.

Trait Implementations

impl Clone for GetMethodOutputBuilder

fn clone(&self) -> GetMethodOutputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetMethodOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetMethodOutputBuilder

fn default() -> GetMethodOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetMethodOutputBuilder

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

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

const 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 GetMethodOutputBuilder