Struct rusoto_apigateway::PutIntegrationRequest
source · [−]pub struct PutIntegrationRequest {Show 17 fields
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 tls_config: Option<TlsConfig>,
pub type_: String,
pub uri: Option<String>,
}
Expand description
Sets up a method's integration.
Fields
cache_key_parameters: Option<Vec<String>>
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters
, these parameters must also be specified for Method requestParameters
.
cache_namespace: Option<String>
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace
. You can specify the same cacheNamespace
across resources to return the same cached data for requests to different resources.
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.
tls_config: Option<TlsConfig>
type_: String
[Required] Specifies a put integration input's type.
uri: Option<String>
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTPPROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a href="https://en.wikipedia.org/wiki/UniformResourceIdentifier" target="blank">RFC-3986 specification, for either standard integration, whereconnectionType
is notVPCLINK
, or private integration, whereconnectionType
isVPCLINK
. For a private HTTP integration, the URI is not used for routing.For
AWS
orAWSPROXY
integrations, the URI is of the formarn: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 anAction={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 ensuingserviceapi
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 ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Trait Implementations
sourceimpl Clone for PutIntegrationRequest
impl Clone for PutIntegrationRequest
sourcefn clone(&self) -> PutIntegrationRequest
fn clone(&self) -> PutIntegrationRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PutIntegrationRequest
impl Debug for PutIntegrationRequest
sourceimpl Default for PutIntegrationRequest
impl Default for PutIntegrationRequest
sourcefn default() -> PutIntegrationRequest
fn default() -> PutIntegrationRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<PutIntegrationRequest> for PutIntegrationRequest
impl PartialEq<PutIntegrationRequest> for PutIntegrationRequest
sourcefn eq(&self, other: &PutIntegrationRequest) -> bool
fn eq(&self, other: &PutIntegrationRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PutIntegrationRequest) -> bool
fn ne(&self, other: &PutIntegrationRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for PutIntegrationRequest
impl Serialize for PutIntegrationRequest
impl StructuralPartialEq for PutIntegrationRequest
Auto Trait Implementations
impl RefUnwindSafe for PutIntegrationRequest
impl Send for PutIntegrationRequest
impl Sync for PutIntegrationRequest
impl Unpin for PutIntegrationRequest
impl UnwindSafe for PutIntegrationRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more