Struct PutMethodInput

#[non_exhaustive]
pub struct PutMethodInput {
    pub rest_api_id: Option<String>,
    pub resource_id: Option<String>,
    pub http_method: Option<String>,
    pub authorization_type: Option<String>,
    pub authorizer_id: Option<String>,
    pub api_key_required: Option<bool>,
    pub operation_name: Option<String>,
    pub request_parameters: Option<HashMap<String, bool>>,
    pub request_models: Option<HashMap<String, String>>,
    pub request_validator_id: Option<String>,
    pub authorization_scopes: Option<Vec<String>>,
}

Request to add a method to an existing Resource 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.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

resource_id: Option<String>

The Resource identifier for the new Method resource.

http_method: Option<String>

Specifies the method request's HTTP method type.

authorization_type: 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.

authorizer_id: Option<String>

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

api_key_required: Option<bool>

Specifies whether the method required a valid ApiKey.

operation_name: 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.

request_parameters: Option<HashMap<String, bool>>

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines 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 body-mapping templates.

request_models: Option<HashMap<String, String>>

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

request_validator_id: Option<String>

The identifier of a RequestValidator for validating the method request.

authorization_scopes: 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.

Implementations

impl PutMethodInput

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

The string identifier of the associated RestApi.

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

The Resource identifier for the new Method resource.

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

Specifies the method request's HTTP method type.

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

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

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

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

Specifies whether the method required a valid ApiKey.

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

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) -> Option<&HashMap<String, bool>>

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines 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 body-mapping templates.

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

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

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

The identifier of a RequestValidator for validating the method request.

pub fn authorization_scopes(&self) -> &[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.

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

impl PutMethodInput

pub fn builder() -> PutMethodInputBuilder

Creates a new builder-style object to manufacture PutMethodInput.

Trait Implementations

impl Clone for PutMethodInput

fn clone(&self) -> PutMethodInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutMethodInput

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

Formats the value using the given formatter.

impl PartialEq for PutMethodInput

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