Package software.amazon.awscdk.services.stepfunctions.tasks

Class CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, StateBaseProps, CallApiGatewayEndpointBaseOptions, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayRestApiEndpointJsonataProps, CallApiGatewayRestApiEndpointOptions, TaskStateBaseOptions, TaskStateJsonataBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CallApiGatewayRestApiEndpointJsonataProps

@Stability(Stable)
@Internal
public static final class CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CallApiGatewayRestApiEndpointJsonataProps

An implementation for CallApiGatewayRestApiEndpointJsonataProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpointJsonataProps

CallApiGatewayRestApiEndpointJsonataProps.Builder, CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CallApiGatewayRestApiEndpointJsonataProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CallApiGatewayRestApiEndpointJsonataProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final IRestApi	getApi()	API to call.
final String	getApiPath()	Path parameters appended after API endpoint.
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final AuthType	getAuthType()	Authentication methods.
final String	getComment()	A comment describing this state.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final TaskInput	getHeaders()	HTTP request information that does not relate to contents of the request.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final HttpMethod	getMethod()	Http method for the API.
final Object	getOutputs()	Used to specify and transform output from the state.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final TaskInput	getQueryParameters()	Query strings attatched to end of request.
final String	getRegion()	Specify a custom Region where the API is deployed, e.g.
final TaskInput	getRequestBody()	HTTP Request body.
final String	getStageName()	Name of the stage where the API is deployed to in API Gateway.
final String	getStateName()	Optional name for this state.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CallApiGatewayRestApiEndpointJsonataProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CallApiGatewayRestApiEndpointJsonataProps.Builder.

Method Details

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

Specified by:

getCredentials in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

Specified by:

getIntegrationPattern in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

getMethod

public final HttpMethod getMethod()

Description copied from interface: CallApiGatewayEndpointBaseOptions

Http method for the API.

Specified by:

getMethod in interface CallApiGatewayEndpointBaseOptions

getApiPath

public final String getApiPath()

Description copied from interface: CallApiGatewayEndpointBaseOptions

Path parameters appended after API endpoint.

Default: - No path

Specified by:

getApiPath in interface CallApiGatewayEndpointBaseOptions

getAuthType

public final AuthType getAuthType()

Description copied from interface: CallApiGatewayEndpointBaseOptions

Authentication methods.

Default: AuthType.NO_AUTH

Specified by:

getAuthType in interface CallApiGatewayEndpointBaseOptions

getHeaders

public final TaskInput getHeaders()

Description copied from interface: CallApiGatewayEndpointBaseOptions

HTTP request information that does not relate to contents of the request.

Default: - No headers

Specified by:

getHeaders in interface CallApiGatewayEndpointBaseOptions

getQueryParameters

public final TaskInput getQueryParameters()

Description copied from interface: CallApiGatewayEndpointBaseOptions

Query strings attatched to end of request.

Default: - No query parameters

Specified by:

getQueryParameters in interface CallApiGatewayEndpointBaseOptions

getRequestBody

public final TaskInput getRequestBody()

Description copied from interface: CallApiGatewayEndpointBaseOptions

HTTP Request body.

Default: - No request body

Specified by:

getRequestBody in interface CallApiGatewayEndpointBaseOptions

getApi

public final IRestApi getApi()

Description copied from interface: CallApiGatewayRestApiEndpointOptions

API to call.

Specified by:

getApi in interface CallApiGatewayRestApiEndpointOptions

getStageName

public final String getStageName()

Description copied from interface: CallApiGatewayRestApiEndpointOptions

Name of the stage where the API is deployed to in API Gateway.

Specified by:

getStageName in interface CallApiGatewayRestApiEndpointOptions

getRegion

public final String getRegion()

Description copied from interface: CallApiGatewayRestApiEndpointOptions

Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

Default: - Uses the Region of the stack containing the `api`.

Specified by:

getRegion in interface CallApiGatewayRestApiEndpointOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object