1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Request to add a method to an existing Resource resource.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct PutMethodInput {
/// <p>The string identifier of the associated RestApi.</p>
pub rest_api_id: ::std::option::Option<::std::string::String>,
/// <p>The Resource identifier for the new Method resource.</p>
pub resource_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies the method request's HTTP method type.</p>
pub http_method: ::std::option::Option<::std::string::String>,
/// <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
pub authorization_type: ::std::option::Option<::std::string::String>,
/// <p>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.</p>
pub authorizer_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies whether the method required a valid ApiKey.</p>
pub api_key_required: bool,
/// <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
pub operation_name: ::std::option::Option<::std::string::String>,
/// <p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
pub request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, bool>>,
/// <p>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.</p>
pub request_models: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>The identifier of a RequestValidator for validating the method request.</p>
pub request_validator_id: ::std::option::Option<::std::string::String>,
/// <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>
pub authorization_scopes: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl PutMethodInput {
/// <p>The string identifier of the associated RestApi.</p>
pub fn rest_api_id(&self) -> ::std::option::Option<&str> {
self.rest_api_id.as_deref()
}
/// <p>The Resource identifier for the new Method resource.</p>
pub fn resource_id(&self) -> ::std::option::Option<&str> {
self.resource_id.as_deref()
}
/// <p>Specifies the method request's HTTP method type.</p>
pub fn http_method(&self) -> ::std::option::Option<&str> {
self.http_method.as_deref()
}
/// <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
pub fn authorization_type(&self) -> ::std::option::Option<&str> {
self.authorization_type.as_deref()
}
/// <p>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.</p>
pub fn authorizer_id(&self) -> ::std::option::Option<&str> {
self.authorizer_id.as_deref()
}
/// <p>Specifies whether the method required a valid ApiKey.</p>
pub fn api_key_required(&self) -> bool {
self.api_key_required
}
/// <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
pub fn operation_name(&self) -> ::std::option::Option<&str> {
self.operation_name.as_deref()
}
/// <p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
pub fn request_parameters(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, bool>> {
self.request_parameters.as_ref()
}
/// <p>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.</p>
pub fn request_models(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.request_models.as_ref()
}
/// <p>The identifier of a RequestValidator for validating the method request.</p>
pub fn request_validator_id(&self) -> ::std::option::Option<&str> {
self.request_validator_id.as_deref()
}
/// <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>
pub fn authorization_scopes(&self) -> ::std::option::Option<&[::std::string::String]> {
self.authorization_scopes.as_deref()
}
}
impl PutMethodInput {
/// Creates a new builder-style object to manufacture [`PutMethodInput`](crate::operation::put_method::PutMethodInput).
pub fn builder() -> crate::operation::put_method::builders::PutMethodInputBuilder {
crate::operation::put_method::builders::PutMethodInputBuilder::default()
}
}
/// A builder for [`PutMethodInput`](crate::operation::put_method::PutMethodInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct PutMethodInputBuilder {
pub(crate) rest_api_id: ::std::option::Option<::std::string::String>,
pub(crate) resource_id: ::std::option::Option<::std::string::String>,
pub(crate) http_method: ::std::option::Option<::std::string::String>,
pub(crate) authorization_type: ::std::option::Option<::std::string::String>,
pub(crate) authorizer_id: ::std::option::Option<::std::string::String>,
pub(crate) api_key_required: ::std::option::Option<bool>,
pub(crate) operation_name: ::std::option::Option<::std::string::String>,
pub(crate) request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, bool>>,
pub(crate) request_models: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) request_validator_id: ::std::option::Option<::std::string::String>,
pub(crate) authorization_scopes: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl PutMethodInputBuilder {
/// <p>The string identifier of the associated RestApi.</p>
pub fn rest_api_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.rest_api_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The string identifier of the associated RestApi.</p>
pub fn set_rest_api_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.rest_api_id = input;
self
}
/// <p>The string identifier of the associated RestApi.</p>
pub fn get_rest_api_id(&self) -> &::std::option::Option<::std::string::String> {
&self.rest_api_id
}
/// <p>The Resource identifier for the new Method resource.</p>
pub fn resource_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.resource_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Resource identifier for the new Method resource.</p>
pub fn set_resource_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.resource_id = input;
self
}
/// <p>The Resource identifier for the new Method resource.</p>
pub fn get_resource_id(&self) -> &::std::option::Option<::std::string::String> {
&self.resource_id
}
/// <p>Specifies the method request's HTTP method type.</p>
pub fn http_method(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.http_method = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the method request's HTTP method type.</p>
pub fn set_http_method(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.http_method = input;
self
}
/// <p>Specifies the method request's HTTP method type.</p>
pub fn get_http_method(&self) -> &::std::option::Option<::std::string::String> {
&self.http_method
}
/// <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
pub fn authorization_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.authorization_type = ::std::option::Option::Some(input.into());
self
}
/// <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
pub fn set_authorization_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.authorization_type = input;
self
}
/// <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
pub fn get_authorization_type(&self) -> &::std::option::Option<::std::string::String> {
&self.authorization_type
}
/// <p>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.</p>
pub fn authorizer_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.authorizer_id = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_authorizer_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.authorizer_id = input;
self
}
/// <p>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.</p>
pub fn get_authorizer_id(&self) -> &::std::option::Option<::std::string::String> {
&self.authorizer_id
}
/// <p>Specifies whether the method required a valid ApiKey.</p>
pub fn api_key_required(mut self, input: bool) -> Self {
self.api_key_required = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether the method required a valid ApiKey.</p>
pub fn set_api_key_required(mut self, input: ::std::option::Option<bool>) -> Self {
self.api_key_required = input;
self
}
/// <p>Specifies whether the method required a valid ApiKey.</p>
pub fn get_api_key_required(&self) -> &::std::option::Option<bool> {
&self.api_key_required
}
/// <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
pub fn operation_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.operation_name = ::std::option::Option::Some(input.into());
self
}
/// <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
pub fn set_operation_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.operation_name = input;
self
}
/// <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
pub fn get_operation_name(&self) -> &::std::option::Option<::std::string::String> {
&self.operation_name
}
/// Adds a key-value pair to `request_parameters`.
///
/// To override the contents of this collection use [`set_request_parameters`](Self::set_request_parameters).
///
/// <p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
pub fn request_parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: bool) -> Self {
let mut hash_map = self.request_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.request_parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
pub fn set_request_parameters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, bool>>) -> Self {
self.request_parameters = input;
self
}
/// <p>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 <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
pub fn get_request_parameters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, bool>> {
&self.request_parameters
}
/// Adds a key-value pair to `request_models`.
///
/// To override the contents of this collection use [`set_request_models`](Self::set_request_models).
///
/// <p>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.</p>
pub fn request_models(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
let mut hash_map = self.request_models.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_models = ::std::option::Option::Some(hash_map);
self
}
/// <p>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.</p>
pub fn set_request_models(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.request_models = input;
self
}
/// <p>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.</p>
pub fn get_request_models(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.request_models
}
/// <p>The identifier of a RequestValidator for validating the method request.</p>
pub fn request_validator_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.request_validator_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of a RequestValidator for validating the method request.</p>
pub fn set_request_validator_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.request_validator_id = input;
self
}
/// <p>The identifier of a RequestValidator for validating the method request.</p>
pub fn get_request_validator_id(&self) -> &::std::option::Option<::std::string::String> {
&self.request_validator_id
}
/// Appends an item to `authorization_scopes`.
///
/// To override the contents of this collection use [`set_authorization_scopes`](Self::set_authorization_scopes).
///
/// <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>
pub fn authorization_scopes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.authorization_scopes.unwrap_or_default();
v.push(input.into());
self.authorization_scopes = ::std::option::Option::Some(v);
self
}
/// <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>
pub fn set_authorization_scopes(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.authorization_scopes = input;
self
}
/// <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> 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.</p>
pub fn get_authorization_scopes(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.authorization_scopes
}
/// Consumes the builder and constructs a [`PutMethodInput`](crate::operation::put_method::PutMethodInput).
pub fn build(self) -> ::std::result::Result<crate::operation::put_method::PutMethodInput, ::aws_smithy_http::operation::error::BuildError> {
::std::result::Result::Ok(crate::operation::put_method::PutMethodInput {
rest_api_id: self.rest_api_id,
resource_id: self.resource_id,
http_method: self.http_method,
authorization_type: self.authorization_type,
authorizer_id: self.authorizer_id,
api_key_required: self.api_key_required.unwrap_or_default(),
operation_name: self.operation_name,
request_parameters: self.request_parameters,
request_models: self.request_models,
request_validator_id: self.request_validator_id,
authorization_scopes: self.authorization_scopes,
})
}
}