Struct aws_sdk_apigateway::client::fluent_builders::PutIntegration

pub struct PutIntegration<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to PutIntegration.

Sets up a method's integration.

Implementations

impl<C, M, R> PutIntegration<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<PutIntegrationOutput, SdkError<PutIntegrationError>> where
    R::Policy: SmithyRetryPolicy<PutIntegrationInputOperationOutputAlias, PutIntegrationOutput, PutIntegrationError, PutIntegrationInputOperationRetryAlias>, 

Sends the request and returns the response.

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

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

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

[Required] The string identifier of the associated RestApi.

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

[Required] The string identifier of the associated RestApi.

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

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

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

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

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

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

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

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

pub fn type(self, input: IntegrationType) -> Self

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

pub fn set_type(self, input: Option<IntegrationType>) -> Self

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

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

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

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

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

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

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

• For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

• For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. 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 {service_api} 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 service_api 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}

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

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

• For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

• For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. 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 {service_api} 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 service_api 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}

pub fn connection_type(self, input: ConnectionType) -> Self

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.

pub fn set_connection_type(self, input: Option<ConnectionType>) -> Self

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.

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

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

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

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

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

Specifies whether credentials are required for a put integration.

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

Specifies whether credentials are required for a put integration.

pub fn request_parameters(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to requestParameters.

To override the contents of this collection use set_request_parameters.

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.

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

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.

pub fn request_templates(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to requestTemplates.

To override the contents of this collection use set_request_templates.

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.

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

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.

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

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.

• WHEN_NO_MATCH 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.

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

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

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.

• WHEN_NO_MATCH 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.

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

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

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.

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

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.

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

Appends an item to cacheKeyParameters.

To override the contents of this collection use set_cache_key_parameters.

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.

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

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.

pub fn content_handling(self, input: ContentHandlingStrategy) -> Self

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.

pub fn set_content_handling(
    self,
    input: Option<ContentHandlingStrategy>
) -> Self

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.

pub fn timeout_in_millis(self, input: i32) -> Self

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

pub fn set_timeout_in_millis(self, input: Option<i32>) -> Self

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

pub fn tls_config(self, input: TlsConfig) -> Self

pub fn set_tls_config(self, input: Option<TlsConfig>) -> Self

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for PutIntegration<C, M, R>

fn clone(&self) -> PutIntegration<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for PutIntegration<C, M, R>

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

Formats the value using the given formatter.