AWS CDK Reference

Appearance

v2.275.0

SqsDestination Class ​

Use an Amazon SQS queue as an event destination.

Source
aws-appconfig/lib/extension.ts
Type last changed
v2.130.0 · 23 Feb 2024

Example ​

ts
declare const queue: sqs.Queue;

new appconfig.Extension(this, 'MyExtension', {
  actions: [
    new appconfig.Action({
      actionPoints: [appconfig.ActionPoint.ON_DEPLOYMENT_START],
      eventDestination: new appconfig.SqsDestination(queue),
    }),
  ],
});
python
# queue: sqs.Queue


appconfig.Extension(self, "MyExtension",
    actions=[
        appconfig.Action(
            action_points=[appconfig.ActionPoint.ON_DEPLOYMENT_START],
            event_destination=appconfig.SqsDestination(queue)
        )
    ]
)
java
Queue queue;


Extension.Builder.create(this, "MyExtension")
        .actions(List.of(
            Action.Builder.create()
                    .actionPoints(List.of(ActionPoint.ON_DEPLOYMENT_START))
                    .eventDestination(new SqsDestination(queue))
                    .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Queue queue;


new Extension(this, "MyExtension", new ExtensionProps {
    Actions = new [] {
        new Action(new ActionProps {
            ActionPoints = new [] { ActionPoint.ON_DEPLOYMENT_START },
            EventDestination = new SqsDestination(queue)
        }) }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var queue Queue


appconfig.NewExtension(this, jsii.String("MyExtension"), &ExtensionProps{
	Actions: []Action{
		appconfig.NewAction(&ActionProps{
			ActionPoints: []ActionPoint{
				appconfig.ActionPoint_ON_DEPLOYMENT_START,
			},
			EventDestination: appconfig.NewSqsDestination(queue),
		}),
	},
})

Initializer ​

ts
new SqsDestination(queue: IQueue)
python
SqsDestination(queue: IQueue)
java
new SqsDestination(IQueue queue)
csharp
new SqsDestination(IQueue queue)
go
NewSqsDestination(Queue IQueue)

Properties ​

extensionUristringextension_uristrextensionUriStringExtensionUristringExtensionUri*string#
The URI of the extension event destination.
policyDocumentmay be undefinedPolicyDocumentpolicy_documentmay be undefinedPolicyDocumentpolicyDocumentmay be undefinedPolicyDocumentPolicyDocumentmay be undefinedPolicyDocumentPolicyDocumentmay be undefinedPolicyDocument#
The IAM policy document to invoke the event destination.
typeSourceTypetypeSourceTypetypeSourceTypeTypeSourceTypeTypeSourceType#
The type of the extension event destination.