# URLEncodingFormat

The style used when applying URL encoding to array values.

- Source: [`aws-stepfunctions-tasks/lib/http/invoke.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/http/invoke.ts#L14)
- Type last changed: v2.138.0 · 18 Apr 2024

## Example

```ts
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(sfn.JsonPath.format('resource/{}/details', sfn.JsonPath.stringAt('$.resourceId'))),
  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

| Member | 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. |

## Referenced by

- [`HttpInvokeJsonataProps`](/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.HttpInvokeJsonataProps).urlEncodingFormat
- [`HttpInvokeJsonPathProps`](/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.HttpInvokeJsonPathProps).urlEncodingFormat
- [`HttpInvokeProps`](/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.HttpInvokeProps).urlEncodingFormat