![]() |
![]()
| ![]() |
![]()
NAMEPaws::ApiGateway::PutIntegration - Arguments for method PutIntegration on Paws::ApiGateway DESCRIPTIONThis class represents the parameters used for calling the method PutIntegration on the Amazon API Gateway service. Use the attributes of this class as arguments to method PutIntegration. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIntegration. SYNOPSISmy $apigateway = Paws->service('ApiGateway'); my $Integration = $apigateway->PutIntegration( HttpMethod => 'MyString', ResourceId => 'MyString', RestApiId => 'MyString', Type => 'HTTP', CacheKeyParameters => [ 'MyString', ... ], # OPTIONAL CacheNamespace => 'MyString', # OPTIONAL ConnectionId => 'MyString', # OPTIONAL ConnectionType => 'INTERNET', # OPTIONAL ContentHandling => 'CONVERT_TO_BINARY', # OPTIONAL Credentials => 'MyString', # OPTIONAL IntegrationHttpMethod => 'MyString', # OPTIONAL PassthroughBehavior => 'MyString', # OPTIONAL RequestParameters => { 'MyString' => 'MyString', }, # OPTIONAL RequestTemplates => { 'MyString' => 'MyString', }, # OPTIONAL TimeoutInMillis => 1, # OPTIONAL TlsConfig => { InsecureSkipVerification => 1, # OPTIONAL }, # OPTIONAL Uri => 'MyString', # OPTIONAL ); # Results: my $CacheKeyParameters = $Integration->CacheKeyParameters; my $CacheNamespace = $Integration->CacheNamespace; my $ConnectionId = $Integration->ConnectionId; my $ConnectionType = $Integration->ConnectionType; my $ContentHandling = $Integration->ContentHandling; my $Credentials = $Integration->Credentials; my $HttpMethod = $Integration->HttpMethod; my $IntegrationResponses = $Integration->IntegrationResponses; my $PassthroughBehavior = $Integration->PassthroughBehavior; my $RequestParameters = $Integration->RequestParameters; my $RequestTemplates = $Integration->RequestTemplates; my $TimeoutInMillis = $Integration->TimeoutInMillis; my $TlsConfig = $Integration->TlsConfig; my $Type = $Integration->Type; my $Uri = $Integration->Uri; # Returns a L<Paws::ApiGateway::Integration> object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutIntegration> ATTRIBUTESCacheKeyParameters => ArrayRef[Str|Undef]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". CacheNamespace => StrSpecifies 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. ConnectionId => StrThe ("id" (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of the VpcLink used for the integration when "connectionType=VPC_LINK" and undefined, otherwise. ConnectionType => StrThe 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". Valid values are: "INTERNET", "VPC_LINK" ContentHandling => StrSpecifies how to handle request payload content type conversions. Supported values are "CONVERT_TO_BINARY" and "CONVERT_TO_TEXT", with the following behaviors:
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. Valid values are: "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" Credentials => StrSpecifies whether credentials are required for a put integration. REQUIRED HttpMethod => Str[Required] Specifies a put integration request's HTTP method. IntegrationHttpMethod => StrSpecifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required. PassthroughBehavior => StrSpecifies 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".
RequestParameters => Paws::ApiGateway::MapOfStringToStringA 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. RequestTemplates => Paws::ApiGateway::MapOfStringToStringRepresents 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. REQUIRED ResourceId => Str[Required] Specifies a put integration request's resource ID. REQUIRED RestApiId => Str[Required] The string identifier of the associated RestApi. TimeoutInMillis => IntCustom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. TlsConfig => Paws::ApiGateway::TlsConfigREQUIRED Type => Str[Required] Specifies a put integration input's type. Valid values are: "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY" Uri => StrSpecifies Uniform Resource Identifier (URI) of the integration endpoint.
SEE ALSOThis class forms part of Paws, documenting arguments for method PutIntegration in Paws::ApiGateway BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|