ApiGatewayTargetParameters

class aws_cdk.aws_pipes_targets_alpha.ApiGatewayTargetParameters(*, header_parameters=None, input_transformation=None, method=None, path=None, path_parameter_values=None, query_string_parameters=None, stage=None)

Bases: object

(experimental) API Gateway REST API target properties.

Parameters:

header_parameters (Optional[Mapping[str, str]]) – (experimental) The headers to send as part of the request invoking the API Gateway REST API. Default: - none
input_transformation (Optional[IInputTransformation]) – (experimental) The input transformation to apply to the message before sending it to the target. Default: - none
method (Optional[str]) – (experimental) The method for API Gateway resource. Default: ‘*’ - ANY
path (Optional[str]) – (experimental) The path for the API Gateway resource. Default: ‘/’
path_parameter_values (Optional[Sequence[str]]) – (experimental) The path parameter values used to populate the API Gateway REST API path wildcards (“*”). Default: - none
query_string_parameters (Optional[Mapping[str, str]]) – (experimental) The query string keys/values that need to be sent as part of request invoking the API Gateway REST API. Default: - none
stage (Optional[str]) – (experimental) The deployment stage for the API Gateway resource. Default: - the value of deploymentStage.stageName of target API Gateway resource.

Stability:

experimental

ExampleMetadata:

infused

Example:

# source_queue: sqs.Queue


fn = lambda_.Function(self, "MyFunc",
    handler="index.handler",
    runtime=lambda_.Runtime.NODEJS_LATEST,
    code=lambda_.Code.from_inline("exports.handler = e => {}")
)

rest_api = api.LambdaRestApi(self, "MyRestAPI", handler=fn)
api_target = targets.ApiGatewayTarget(rest_api,
    input_transformation=pipes.InputTransformation.from_object({"body": "👀"})
)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=api_target
)

Attributes

header_parameters

(experimental) The headers to send as part of the request invoking the API Gateway REST API.

Default:

none

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-headerparameters

Stability:

experimental

input_transformation

(experimental) The input transformation to apply to the message before sending it to the target.

Default:

none

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

Stability:

experimental

method

(experimental) The method for API Gateway resource.

Default:: ‘*’ - ANY
Stability:: experimental

path

(experimental) The path for the API Gateway resource.

Default:: ‘/’
Stability:: experimental

path_parameter_values

(experimental) The path parameter values used to populate the API Gateway REST API path wildcards (“*”).

Default:

none

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues

Stability:

experimental

query_string_parameters

(experimental) The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

Default:

none

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html#cfn-pipes-pipe-pipetargethttpparameters-querystringparameters

Stability:

experimental

stage

(experimental) The deployment stage for the API Gateway resource.

Default:

the value of deploymentStage.stageName of target API Gateway resource.

Stability:

experimental