Struct rusoto_apigateway::PutIntegrationRequest

pub struct PutIntegrationRequest {
    pub cache_key_parameters: Option<Vec<String>>,
    pub cache_namespace: Option<String>,
    pub connection_id: Option<String>,
    pub connection_type: Option<String>,
    pub content_handling: Option<String>,
    pub credentials: Option<String>,
    pub http_method: String,
    pub integration_http_method: Option<String>,
    pub passthrough_behavior: Option<String>,
    pub request_parameters: Option<HashMap<String, String>>,
    pub request_templates: Option<HashMap<String, String>>,
    pub resource_id: String,
    pub rest_api_id: String,
    pub timeout_in_millis: Option<i64>,
    pub type_: String,
    pub uri: Option<String>,
}

Sets up a method's integration.

Fields

cache_key_parameters: Option<Vec<String>>

An API-specific tag group of related cached parameters.

cache_namespace: Option<String>

A list of request parameters whose values are to be cached.

connection_id: Option<String>

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

connection_type: Option<String>

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

content_handling: Option<String>

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

• CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

• CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

credentials: Option<String>

Specifies whether credentials are required for a put integration.

http_method: String

[Required] Specifies a put integration request's HTTP method.

integration_http_method: Option<String>

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

passthrough_behavior: Option<String>

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: WHENNOMATCH, WHENNOTEMPLATES, and NEVER.

• WHENNOMATCH passes the request body for unmapped content types through to the integration back end without transformation.

• NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

• WHENNOTEMPLATES 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 415 response.

request_parameters: Option<HashMap<String, String>>

A key-value map specifying request parameters that are passed from the method request to the back end. 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 back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

request_templates: Option<HashMap<String, String>>

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.

resource_id: String

[Required] Specifies a put integration request's resource ID.

rest_api_id: String

[Required] The string identifier of the associated RestApi.

timeout_in_millis: Option<i64>

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

type_: String

[Required] Specifies a put integration input's type.

uri: Option<String>

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

• For HTTP or HTTPPROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a target="blank" href="https://en.wikipedia.org/wiki/UniformResourceIdentifier">RFC-3986 specification, for either standard integration, where connectionType is not VPCLINK, or private integration, where connectionType is VPCLINK. For a private HTTP integration, the URI is not used for routing.

• For AWS or AWSPROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{serviceapi}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {serviceapi} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing serviceapi refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Trait Implementations

impl Clone for PutIntegrationRequest

fn clone(&self) -> PutIntegrationRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutIntegrationRequest

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

Formats the value using the given formatter.

impl Default for PutIntegrationRequest

fn default() -> PutIntegrationRequest

Returns the "default value" for a type.

impl PartialEq<PutIntegrationRequest> for PutIntegrationRequest

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PutIntegrationRequest) -> bool

This method tests for !=.

impl Serialize for PutIntegrationRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PutIntegrationRequest