enum URLEncodingFormat
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.URLEncodingFormat |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#URLEncodingFormat |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.URLEncodingFormat |
![]() | aws_cdk.aws_stepfunctions_tasks.URLEncodingFormat |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » URLEncodingFormat |
The style used when applying URL encoding to array values.
Example
import * as events from 'aws-cdk-lib/aws-events';
const connection = new events.Connection(this, 'Connection', {
authorization: events.Authorization.basic('username', SecretValue.unsafePlainText('password')),
});
new tasks.HttpInvoke(this, 'Invoke HTTP API', {
apiRoot: 'https://api.example.com',
apiEndpoint: sfn.TaskInput.fromText('path/to/resource'),
body: sfn.TaskInput.fromObject({ foo: 'bar' }),
connection,
headers: sfn.TaskInput.fromObject({ 'Content-Type': 'application/json' }),
method: sfn.TaskInput.fromText('POST'),
queryStringParameters: sfn.TaskInput.fromObject({ id: '123' }),
urlEncodingFormat: tasks.URLEncodingFormat.BRACKETS,
});
Members
Name | Description |
---|---|
BRACKETS | Encode arrays using brackets. |
COMMAS | Encode arrays using commas. |
DEFAULT | Apply the default URL encoding style (INDICES). |
INDICES | Encode arrays using the index value. |
NONE | Do not apply URL encoding. |
REPEAT | Repeat key for each item in the array. |
BRACKETS
Encode arrays using brackets.
For example, {'array': ['a','b','c']} encodes to 'array[]=a&array[]=b&array[]=c'
COMMAS
Encode arrays using commas.
For example, {'array': ['a','b','c']} encodes to 'array=a,b,c,d'
DEFAULT
Apply the default URL encoding style (INDICES).
INDICES
Encode arrays using the index value.
For example, {'array': ['a','b','c']} encodes to 'array[0]=a&array[1]=b&array[2]=c'
NONE
Do not apply URL encoding.
REPEAT
Repeat key for each item in the array.
For example, {'array': ['a','b','c']} encodes to 'array[]=a&array[]=b&array[]=c'