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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetIntegrationOutput {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub api_gateway_managed: ::std::option::Option<bool>,
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub connection_id: ::std::option::Option<::std::string::String>,
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub connection_type: ::std::option::Option<crate::types::ConnectionType>,
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub content_handling_strategy: ::std::option::Option<crate::types::ContentHandlingStrategy>,
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub credentials_arn: ::std::option::Option<::std::string::String>,
/// <p>Represents the description of an integration.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>Represents the identifier of an integration.</p>
pub integration_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies the integration's HTTP method type.</p>
pub integration_method: ::std::option::Option<::std::string::String>,
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub integration_response_selection_expression: ::std::option::Option<::std::string::String>,
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub integration_subtype: ::std::option::Option<::std::string::String>,
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub integration_type: ::std::option::Option<crate::types::IntegrationType>,
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub integration_uri: ::std::option::Option<::std::string::String>,
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub passthrough_behavior: ::std::option::Option<crate::types::PassthroughBehavior>,
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub payload_format_version: ::std::option::Option<::std::string::String>,
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub request_templates: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub response_parameters: ::std::option::Option<
::std::collections::HashMap<::std::string::String, ::std::collections::HashMap<::std::string::String, ::std::string::String>>,
>,
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub template_selection_expression: ::std::option::Option<::std::string::String>,
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub timeout_in_millis: ::std::option::Option<i32>,
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub tls_config: ::std::option::Option<crate::types::TlsConfig>,
_request_id: Option<String>,
}
impl GetIntegrationOutput {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn api_gateway_managed(&self) -> ::std::option::Option<bool> {
self.api_gateway_managed
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn connection_id(&self) -> ::std::option::Option<&str> {
self.connection_id.as_deref()
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn connection_type(&self) -> ::std::option::Option<&crate::types::ConnectionType> {
self.connection_type.as_ref()
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(&self) -> ::std::option::Option<&crate::types::ContentHandlingStrategy> {
self.content_handling_strategy.as_ref()
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn credentials_arn(&self) -> ::std::option::Option<&str> {
self.credentials_arn.as_deref()
}
/// <p>Represents the description of an integration.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Represents the identifier of an integration.</p>
pub fn integration_id(&self) -> ::std::option::Option<&str> {
self.integration_id.as_deref()
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn integration_method(&self) -> ::std::option::Option<&str> {
self.integration_method.as_deref()
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn integration_response_selection_expression(&self) -> ::std::option::Option<&str> {
self.integration_response_selection_expression.as_deref()
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn integration_subtype(&self) -> ::std::option::Option<&str> {
self.integration_subtype.as_deref()
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn integration_type(&self) -> ::std::option::Option<&crate::types::IntegrationType> {
self.integration_type.as_ref()
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn integration_uri(&self) -> ::std::option::Option<&str> {
self.integration_uri.as_deref()
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn passthrough_behavior(&self) -> ::std::option::Option<&crate::types::PassthroughBehavior> {
self.passthrough_behavior.as_ref()
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn payload_format_version(&self) -> ::std::option::Option<&str> {
self.payload_format_version.as_deref()
}
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn request_parameters(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.request_parameters.as_ref()
}
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn request_templates(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.request_templates.as_ref()
}
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn response_parameters(
&self,
) -> ::std::option::Option<
&::std::collections::HashMap<::std::string::String, ::std::collections::HashMap<::std::string::String, ::std::string::String>>,
> {
self.response_parameters.as_ref()
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn template_selection_expression(&self) -> ::std::option::Option<&str> {
self.template_selection_expression.as_deref()
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn timeout_in_millis(&self) -> ::std::option::Option<i32> {
self.timeout_in_millis
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn tls_config(&self) -> ::std::option::Option<&crate::types::TlsConfig> {
self.tls_config.as_ref()
}
}
impl ::aws_types::request_id::RequestId for GetIntegrationOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetIntegrationOutput {
/// Creates a new builder-style object to manufacture [`GetIntegrationOutput`](crate::operation::get_integration::GetIntegrationOutput).
pub fn builder() -> crate::operation::get_integration::builders::GetIntegrationOutputBuilder {
crate::operation::get_integration::builders::GetIntegrationOutputBuilder::default()
}
}
/// A builder for [`GetIntegrationOutput`](crate::operation::get_integration::GetIntegrationOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetIntegrationOutputBuilder {
pub(crate) api_gateway_managed: ::std::option::Option<bool>,
pub(crate) connection_id: ::std::option::Option<::std::string::String>,
pub(crate) connection_type: ::std::option::Option<crate::types::ConnectionType>,
pub(crate) content_handling_strategy: ::std::option::Option<crate::types::ContentHandlingStrategy>,
pub(crate) credentials_arn: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) integration_id: ::std::option::Option<::std::string::String>,
pub(crate) integration_method: ::std::option::Option<::std::string::String>,
pub(crate) integration_response_selection_expression: ::std::option::Option<::std::string::String>,
pub(crate) integration_subtype: ::std::option::Option<::std::string::String>,
pub(crate) integration_type: ::std::option::Option<crate::types::IntegrationType>,
pub(crate) integration_uri: ::std::option::Option<::std::string::String>,
pub(crate) passthrough_behavior: ::std::option::Option<crate::types::PassthroughBehavior>,
pub(crate) payload_format_version: ::std::option::Option<::std::string::String>,
pub(crate) request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) request_templates: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) response_parameters: ::std::option::Option<
::std::collections::HashMap<::std::string::String, ::std::collections::HashMap<::std::string::String, ::std::string::String>>,
>,
pub(crate) template_selection_expression: ::std::option::Option<::std::string::String>,
pub(crate) timeout_in_millis: ::std::option::Option<i32>,
pub(crate) tls_config: ::std::option::Option<crate::types::TlsConfig>,
_request_id: Option<String>,
}
impl GetIntegrationOutputBuilder {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn set_api_gateway_managed(mut self, input: ::std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn get_api_gateway_managed(&self) -> &::std::option::Option<bool> {
&self.api_gateway_managed
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn connection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.connection_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn set_connection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.connection_id = input;
self
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn get_connection_id(&self) -> &::std::option::Option<::std::string::String> {
&self.connection_id
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn connection_type(mut self, input: crate::types::ConnectionType) -> Self {
self.connection_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn set_connection_type(mut self, input: ::std::option::Option<crate::types::ConnectionType>) -> Self {
self.connection_type = input;
self
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn get_connection_type(&self) -> &::std::option::Option<crate::types::ConnectionType> {
&self.connection_type
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(mut self, input: crate::types::ContentHandlingStrategy) -> Self {
self.content_handling_strategy = ::std::option::Option::Some(input);
self
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn set_content_handling_strategy(mut self, input: ::std::option::Option<crate::types::ContentHandlingStrategy>) -> Self {
self.content_handling_strategy = input;
self
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn get_content_handling_strategy(&self) -> &::std::option::Option<crate::types::ContentHandlingStrategy> {
&self.content_handling_strategy
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn credentials_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.credentials_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn set_credentials_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.credentials_arn = input;
self
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn get_credentials_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.credentials_arn
}
/// <p>Represents the description of an integration.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>Represents the description of an integration.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Represents the description of an integration.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>Represents the identifier of an integration.</p>
pub fn integration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.integration_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Represents the identifier of an integration.</p>
pub fn set_integration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.integration_id = input;
self
}
/// <p>Represents the identifier of an integration.</p>
pub fn get_integration_id(&self) -> &::std::option::Option<::std::string::String> {
&self.integration_id
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn integration_method(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.integration_method = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn set_integration_method(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.integration_method = input;
self
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn get_integration_method(&self) -> &::std::option::Option<::std::string::String> {
&self.integration_method
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn integration_response_selection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.integration_response_selection_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn set_integration_response_selection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.integration_response_selection_expression = input;
self
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn get_integration_response_selection_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.integration_response_selection_expression
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn integration_subtype(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.integration_subtype = ::std::option::Option::Some(input.into());
self
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn set_integration_subtype(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.integration_subtype = input;
self
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn get_integration_subtype(&self) -> &::std::option::Option<::std::string::String> {
&self.integration_subtype
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn integration_type(mut self, input: crate::types::IntegrationType) -> Self {
self.integration_type = ::std::option::Option::Some(input);
self
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn set_integration_type(mut self, input: ::std::option::Option<crate::types::IntegrationType>) -> Self {
self.integration_type = input;
self
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn get_integration_type(&self) -> &::std::option::Option<crate::types::IntegrationType> {
&self.integration_type
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn integration_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.integration_uri = ::std::option::Option::Some(input.into());
self
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn set_integration_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.integration_uri = input;
self
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn get_integration_uri(&self) -> &::std::option::Option<::std::string::String> {
&self.integration_uri
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn passthrough_behavior(mut self, input: crate::types::PassthroughBehavior) -> Self {
self.passthrough_behavior = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn set_passthrough_behavior(mut self, input: ::std::option::Option<crate::types::PassthroughBehavior>) -> Self {
self.passthrough_behavior = input;
self
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn get_passthrough_behavior(&self) -> &::std::option::Option<crate::types::PassthroughBehavior> {
&self.passthrough_behavior
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn payload_format_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.payload_format_version = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn set_payload_format_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.payload_format_version = input;
self
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn get_payload_format_version(&self) -> &::std::option::Option<::std::string::String> {
&self.payload_format_version
}
/// Adds a key-value pair to `request_parameters`.
///
/// To override the contents of this collection use [`set_request_parameters`](Self::set_request_parameters).
///
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn request_parameters(
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_parameters.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn set_request_parameters(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.request_parameters = input;
self
}
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn get_request_parameters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.request_parameters
}
/// Adds a key-value pair to `request_templates`.
///
/// To override the contents of this collection use [`set_request_templates`](Self::set_request_templates).
///
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn request_templates(
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_templates.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_templates = ::std::option::Option::Some(hash_map);
self
}
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn set_request_templates(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.request_templates = input;
self
}
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn get_request_templates(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.request_templates
}
/// Adds a key-value pair to `response_parameters`.
///
/// To override the contents of this collection use [`set_response_parameters`](Self::set_response_parameters).
///
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn response_parameters(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: ::std::collections::HashMap<::std::string::String, ::std::string::String>,
) -> Self {
let mut hash_map = self.response_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.response_parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn set_response_parameters(
mut self,
input: ::std::option::Option<
::std::collections::HashMap<::std::string::String, ::std::collections::HashMap<::std::string::String, ::std::string::String>>,
>,
) -> Self {
self.response_parameters = input;
self
}
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn get_response_parameters(
&self,
) -> &::std::option::Option<
::std::collections::HashMap<::std::string::String, ::std::collections::HashMap<::std::string::String, ::std::string::String>>,
> {
&self.response_parameters
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn template_selection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.template_selection_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn set_template_selection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.template_selection_expression = input;
self
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn get_template_selection_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.template_selection_expression
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn timeout_in_millis(mut self, input: i32) -> Self {
self.timeout_in_millis = ::std::option::Option::Some(input);
self
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn set_timeout_in_millis(mut self, input: ::std::option::Option<i32>) -> Self {
self.timeout_in_millis = input;
self
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn get_timeout_in_millis(&self) -> &::std::option::Option<i32> {
&self.timeout_in_millis
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn tls_config(mut self, input: crate::types::TlsConfig) -> Self {
self.tls_config = ::std::option::Option::Some(input);
self
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn set_tls_config(mut self, input: ::std::option::Option<crate::types::TlsConfig>) -> Self {
self.tls_config = input;
self
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn get_tls_config(&self) -> &::std::option::Option<crate::types::TlsConfig> {
&self.tls_config
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`GetIntegrationOutput`](crate::operation::get_integration::GetIntegrationOutput).
pub fn build(self) -> crate::operation::get_integration::GetIntegrationOutput {
crate::operation::get_integration::GetIntegrationOutput {
api_gateway_managed: self.api_gateway_managed,
connection_id: self.connection_id,
connection_type: self.connection_type,
content_handling_strategy: self.content_handling_strategy,
credentials_arn: self.credentials_arn,
description: self.description,
integration_id: self.integration_id,
integration_method: self.integration_method,
integration_response_selection_expression: self.integration_response_selection_expression,
integration_subtype: self.integration_subtype,
integration_type: self.integration_type,
integration_uri: self.integration_uri,
passthrough_behavior: self.passthrough_behavior,
payload_format_version: self.payload_format_version,
request_parameters: self.request_parameters,
request_templates: self.request_templates,
response_parameters: self.response_parameters,
template_selection_expression: self.template_selection_expression,
timeout_in_millis: self.timeout_in_millis,
tls_config: self.tls_config,
_request_id: self._request_id,
}
}
}