AwsIntegrationProps¶
-
class
aws_cdk.aws_apigateway.
AwsIntegrationProps
(*, service, action=None, action_parameters=None, integration_http_method=None, options=None, path=None, proxy=None, region=None, subdomain=None)¶ Bases:
object
- Parameters
service (
str
) – The name of the integrated AWS service (e.g.s3
).action (
Optional
[str
]) – The AWS action to perform in the integration. UseactionParams
to specify key-value params for the action. Mutually exclusive withpath
.action_parameters (
Optional
[Mapping
[str
,str
]]) – Parameters for the action.action
must be set, andpath
must be undefined. The action params will be URL encoded.integration_http_method (
Optional
[str
]) – The integration’s HTTP method type. Default: POSToptions (
Optional
[IntegrationOptions
]) – Integration options, such as content handling, request/response mapping, etc.path (
Optional
[str
]) – The path to use for path-base APIs. For example, for S3 GET, you can set path tobucket/key
. For lambda, you can set path to2015-03-31/functions/${function-arn}/invocations
Mutually exclusive with theaction
options.proxy (
Optional
[bool
]) – Use AWS_PROXY integration. Default: falseregion (
Optional
[str
]) – The region of the integrated AWS service. Default: - same region as the stacksubdomain (
Optional
[str
]) – A designated subdomain supported by certain AWS service for fast host-name lookup.
- ExampleMetadata
infused
Example:
get_message_integration = apigateway.AwsIntegration( service="sqs", path="queueName", region="eu-west-1" )
Attributes
-
action
¶ The AWS action to perform in the integration.
Use
actionParams
to specify key-value params for the action.Mutually exclusive with
path
.- Return type
Optional
[str
]
-
action_parameters
¶ Parameters for the action.
action
must be set, andpath
must be undefined. The action params will be URL encoded.- Return type
Optional
[Mapping
[str
,str
]]
-
integration_http_method
¶ The integration’s HTTP method type.
- Default
POST
- Return type
Optional
[str
]
-
options
¶ Integration options, such as content handling, request/response mapping, etc.
- Return type
Optional
[IntegrationOptions
]
-
path
¶ The path to use for path-base APIs.
For example, for S3 GET, you can set path to
bucket/key
. For lambda, you can set path to2015-03-31/functions/${function-arn}/invocations
Mutually exclusive with the
action
options.- Return type
Optional
[str
]
-
proxy
¶ Use AWS_PROXY integration.
- Default
false
- Return type
Optional
[bool
]
-
region
¶ The region of the integrated AWS service.
- Default
same region as the stack
- Return type
Optional
[str
]
-
service
¶ The name of the integrated AWS service (e.g.
s3
).- Return type
str
-
subdomain
¶ A designated subdomain supported by certain AWS service for fast host-name lookup.
- Return type
Optional
[str
]