interface HttpsActionProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.IoT.Actions.Alpha.HttpsActionProps
Go	github.com/aws/aws-cdk-go/awscdkiotactionsalpha/v2#HttpsActionProps
Java	software.amazon.awscdk.services.iot.actions.alpha.HttpsActionProps
Python	aws_cdk.aws_iot_actions_alpha.HttpsActionProps
TypeScript (source)	@aws-cdk/aws-iot-actions-alpha » HttpsActionProps

Configuration properties of an HTTPS action.

See also: https://docs.aws.amazon.com/iot/latest/developerguide/https-rule-action.html

Example

const topicRule = new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323(
    "SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'",
  ),
});

topicRule.addAction(
  new actions.HttpsAction('https://example.com/endpoint', {
    confirmationUrl: 'https://example.com',
    headers: [
      { key: 'key0', value: 'value0' },
      { key: 'key1', value: 'value1' },
    ],
    auth: { serviceName: 'serviceName', signingRegion: 'us-east-1' },
  }),
);

Properties

Name	Type	Description
auth?🔹	HttpActionSigV4Auth	Use Sigv4 authorization.
confirmationUrl?🔹	string	If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.
headers?🔹	HttpActionHeader[]	The headers to include in the HTTPS request to the endpoint.
role?🔹	IRole	The IAM role that allows access to AWS service.

---

auth?🔹

Type: HttpActionSigV4Auth (optional)

Use Sigv4 authorization.

---

confirmationUrl?🔹

Type: string (optional)

If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.

---

headers?🔹

Type: HttpActionHeader[] (optional)

The headers to include in the HTTPS request to the endpoint.

---

role?🔹

Type: IRole (optional, default: a new role will be created)

The IAM role that allows access to AWS service.