Struct aws_sdk_apigateway::operation::put_method::builders::PutMethodFluentBuilder

pub struct PutMethodFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutMethod.

Add a method to an existing Resource resource.

Implementations

impl PutMethodFluentBuilder

pub fn as_input(&self) -> &PutMethodInputBuilder

Access the PutMethod as a reference.

pub async fn send( self ) -> Result<PutMethodOutput, SdkError<PutMethodError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<PutMethodOutput, PutMethodError>, SdkError<PutMethodError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

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

The Resource identifier for the new Method resource.

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

The Resource identifier for the new Method resource.

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

The Resource identifier for the new Method resource.

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

Specifies the method request's HTTP method type.

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

Specifies the method request's HTTP method type.

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

Specifies the method request's HTTP method type.

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

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 set_authorizer_id(self, input: Option<String>) -> Self

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 get_authorizer_id(&self) -> &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.

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

Specifies whether the method required a valid ApiKey.

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

Specifies whether the method required a valid ApiKey.

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

Specifies whether the method required a valid ApiKey.

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 requestParameters.

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 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 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 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 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 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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to requestModels.

To override the contents of this collection use set_request_models.

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 set_request_models(self, input: Option<HashMap<String, String>>) -> Self

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 get_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, input: impl Into<String>) -> Self

The identifier of a RequestValidator for validating the method request.

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

The identifier of a RequestValidator for validating the method request.

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

The identifier of a RequestValidator for validating the method request.

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

Appends an item to authorizationScopes.

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.

Trait Implementations

impl Clone for PutMethodFluentBuilder

fn clone(&self) -> PutMethodFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutMethodFluentBuilder

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

Formats the value using the given formatter.