aws-cdk-lib.aws_eventsv2.CfnSubscriber

CfnSubscriber L1 construct

Resource type definition for AWS::EventsV2::Subscriber, an Amazon EventBridge subscription that delivers events from an event bus to a target.

Canonical identity is the combination of bus, name, and target. Replacement uses delete_then_create.

Construct›CfnElement›CfnRefElement›CfnResource›CfnSubscriber

implements

• IInspectable,
• ITaggableV2,
• IEnvironmentAware,
• ISubscriberRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::EventsV2::Subscriber

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const cfnSubscriber = new eventsv2.CfnSubscriber(this, 'MyCfnSubscriber', {
  eventBusArn: 'eventBusArn',
  invokeConfiguration: {
    roleArn: 'roleArn',
    targetArn: 'targetArn',

    // the properties below are optional
    eventBusV2Parameters: {
      deduplicationConfiguration: {
        deduplicationType: 'deduplicationType',
      },
      metadata: {
        metadataKey: 'metadata',
      },
      systemMetadata: {
        deduplicationId: 'deduplicationId',
        eventGroupId: 'eventGroupId',
      },
    },
    httpParameters: {
      headerParameters: {
        headerParametersKey: 'headerParameters',
      },
      invocationTimeoutSeconds: 'invocationTimeoutSeconds',
      pathParameterValues: ['pathParameterValues'],
      queryStringParameters: {
        queryStringParametersKey: 'queryStringParameters',
      },
    },
    kinesisParameters: {
      explicitHashKey: 'explicitHashKey',
      partitionKey: 'partitionKey',
    },
    lambdaParameters: {
      durableExecutionName: 'durableExecutionName',
      invocationTimeoutSeconds: 'invocationTimeoutSeconds',
      invocationType: 'invocationType',
      qualifier: 'qualifier',
      tenantId: 'tenantId',
    },
    snsParameters: {
      messageAttributes: {
        messageAttributesKey: {
          dataType: 'dataType',

          // the properties below are optional
          binaryValue: 'binaryValue',
          stringValue: 'stringValue',
        },
      },
      messageDeduplicationId: 'messageDeduplicationId',
      messageGroupId: 'messageGroupId',
      messageStructure: 'messageStructure',
      subject: 'subject',
    },
    sqsParameters: {
      delaySeconds: 'delaySeconds',
      messageAttributes: {
        messageAttributesKey: {
          dataType: 'dataType',

          // the properties below are optional
          binaryValue: 'binaryValue',
          stringValue: 'stringValue',
        },
      },
      messageDeduplicationId: 'messageDeduplicationId',
      messageGroupId: 'messageGroupId',
      messageSystemAttributes: {
        messageSystemAttributesKey: {
          dataType: 'dataType',

          // the properties below are optional
          binaryValue: 'binaryValue',
          stringValue: 'stringValue',
        },
      },
    },
    stepFunctionsParameters: {
      invocationTimeoutSeconds: 'invocationTimeoutSeconds',
      invocationType: 'invocationType',
      name: 'name',
      traceHeader: 'traceHeader',
    },
    universalTargetParameters: {
      input: 'input',

      // the properties below are optional
      invocationTimeoutSeconds: 'invocationTimeoutSeconds',
    },
  },
  name: 'name',

  // the properties below are optional
  batchConfiguration: {
    maxBatchSize: 123,
    maxBatchWindowInSeconds: 123,
  },
  description: 'description',
  filterConfiguration: {
    filters: [{
      pattern: 'pattern',
      scope: 'scope',
    }],

    // the properties below are optional
    language: 'language',
  },
  logConfiguration: {
    includePayload: 'includePayload',
    level: 'level',
  },
  onFailureConfiguration: {
    arn: 'arn',
  },
  pointInTimeConfiguration: {
    pointType: 'pointType',

    // the properties below are optional
    endPoint: 123,
    startingPoint: 123,
  },
  resumePosition: 'resumePosition',
  retryPolicy: {
    maxEventAgeInSeconds: 123,
    maxRetryAttempts: 123,
    retryStrategy: 'retryStrategy',
  },
  startingPosition: 'startingPosition',
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transformer: {
    jsonataConfiguration: {
      expression: 'expression',
    },
    type: 'type',
  },
  type: 'type',
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eventsv2 as eventsv2

cfn_subscriber = eventsv2.CfnSubscriber(self, "MyCfnSubscriber",
    event_bus_arn="eventBusArn",
    invoke_configuration=eventsv2.CfnSubscriber.InvokeConfigurationProperty(
        role_arn="roleArn",
        target_arn="targetArn",

        # the properties below are optional
        event_bus_v2_parameters=eventsv2.CfnSubscriber.EventBusV2ParametersProperty(
            deduplication_configuration=eventsv2.CfnSubscriber.DeduplicationConfigurationProperty(
                deduplication_type="deduplicationType"
            ),
            metadata={
                "metadata_key": "metadata"
            },
            system_metadata=eventsv2.CfnSubscriber.EventBusV2SystemMetadataProperty(
                deduplication_id="deduplicationId",
                event_group_id="eventGroupId"
            )
        ),
        http_parameters=eventsv2.CfnSubscriber.HttpParametersProperty(
            header_parameters={
                "header_parameters_key": "headerParameters"
            },
            invocation_timeout_seconds="invocationTimeoutSeconds",
            path_parameter_values=["pathParameterValues"],
            query_string_parameters={
                "query_string_parameters_key": "queryStringParameters"
            }
        ),
        kinesis_parameters=eventsv2.CfnSubscriber.KinesisParametersProperty(
            explicit_hash_key="explicitHashKey",
            partition_key="partitionKey"
        ),
        lambda_parameters=eventsv2.CfnSubscriber.LambdaParametersProperty(
            durable_execution_name="durableExecutionName",
            invocation_timeout_seconds="invocationTimeoutSeconds",
            invocation_type="invocationType",
            qualifier="qualifier",
            tenant_id="tenantId"
        ),
        sns_parameters=eventsv2.CfnSubscriber.SnsParametersProperty(
            message_attributes={
                "message_attributes_key": eventsv2.CfnSubscriber.MessageAttributeValueProperty(
                    data_type="dataType",

                    # the properties below are optional
                    binary_value="binaryValue",
                    string_value="stringValue"
                )
            },
            message_deduplication_id="messageDeduplicationId",
            message_group_id="messageGroupId",
            message_structure="messageStructure",
            subject="subject"
        ),
        sqs_parameters=eventsv2.CfnSubscriber.SqsParametersProperty(
            delay_seconds="delaySeconds",
            message_attributes={
                "message_attributes_key": eventsv2.CfnSubscriber.MessageAttributeValueProperty(
                    data_type="dataType",

                    # the properties below are optional
                    binary_value="binaryValue",
                    string_value="stringValue"
                )
            },
            message_deduplication_id="messageDeduplicationId",
            message_group_id="messageGroupId",
            message_system_attributes={
                "message_system_attributes_key": eventsv2.CfnSubscriber.MessageAttributeValueProperty(
                    data_type="dataType",

                    # the properties below are optional
                    binary_value="binaryValue",
                    string_value="stringValue"
                )
            }
        ),
        step_functions_parameters=eventsv2.CfnSubscriber.StepFunctionsParametersProperty(
            invocation_timeout_seconds="invocationTimeoutSeconds",
            invocation_type="invocationType",
            name="name",
            trace_header="traceHeader"
        ),
        universal_target_parameters=eventsv2.CfnSubscriber.UniversalTargetParametersProperty(
            input="input",

            # the properties below are optional
            invocation_timeout_seconds="invocationTimeoutSeconds"
        )
    ),
    name="name",

    # the properties below are optional
    batch_configuration=eventsv2.CfnSubscriber.BatchConfigurationProperty(
        max_batch_size=123,
        max_batch_window_in_seconds=123
    ),
    description="description",
    filter_configuration=eventsv2.CfnSubscriber.FilterConfigurationProperty(
        filters=[eventsv2.CfnSubscriber.FilterProperty(
            pattern="pattern",
            scope="scope"
        )],

        # the properties below are optional
        language="language"
    ),
    log_configuration=eventsv2.CfnSubscriber.LogConfigurationProperty(
        include_payload="includePayload",
        level="level"
    ),
    on_failure_configuration=eventsv2.CfnSubscriber.OnFailureConfigurationProperty(
        arn="arn"
    ),
    point_in_time_configuration=eventsv2.CfnSubscriber.PointInTimeConfigurationProperty(
        point_type="pointType",

        # the properties below are optional
        end_point=123,
        starting_point=123
    ),
    resume_position="resumePosition",
    retry_policy=eventsv2.CfnSubscriber.RetryPolicyProperty(
        max_event_age_in_seconds=123,
        max_retry_attempts=123,
        retry_strategy="retryStrategy"
    ),
    starting_position="startingPosition",
    state="state",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transformer=eventsv2.CfnSubscriber.TransformerProperty(
        jsonata_configuration=eventsv2.CfnSubscriber.JsonataConfigurationProperty(
            expression="expression"
        ),
        type="type"
    ),
    type="type"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.eventsv2.*;

CfnSubscriber cfnSubscriber = CfnSubscriber.Builder.create(this, "MyCfnSubscriber")
        .eventBusArn("eventBusArn")
        .invokeConfiguration(InvokeConfigurationProperty.builder()
                .roleArn("roleArn")
                .targetArn("targetArn")

                // the properties below are optional
                .eventBusV2Parameters(EventBusV2ParametersProperty.builder()
                        .deduplicationConfiguration(DeduplicationConfigurationProperty.builder()
                                .deduplicationType("deduplicationType")
                                .build())
                        .metadata(Map.of(
                                "metadataKey", "metadata"))
                        .systemMetadata(EventBusV2SystemMetadataProperty.builder()
                                .deduplicationId("deduplicationId")
                                .eventGroupId("eventGroupId")
                                .build())
                        .build())
                .httpParameters(HttpParametersProperty.builder()
                        .headerParameters(Map.of(
                                "headerParametersKey", "headerParameters"))
                        .invocationTimeoutSeconds("invocationTimeoutSeconds")
                        .pathParameterValues(List.of("pathParameterValues"))
                        .queryStringParameters(Map.of(
                                "queryStringParametersKey", "queryStringParameters"))
                        .build())
                .kinesisParameters(KinesisParametersProperty.builder()
                        .explicitHashKey("explicitHashKey")
                        .partitionKey("partitionKey")
                        .build())
                .lambdaParameters(LambdaParametersProperty.builder()
                        .durableExecutionName("durableExecutionName")
                        .invocationTimeoutSeconds("invocationTimeoutSeconds")
                        .invocationType("invocationType")
                        .qualifier("qualifier")
                        .tenantId("tenantId")
                        .build())
                .snsParameters(SnsParametersProperty.builder()
                        .messageAttributes(Map.of(
                                "messageAttributesKey", MessageAttributeValueProperty.builder()
                                        .dataType("dataType")

                                        // the properties below are optional
                                        .binaryValue("binaryValue")
                                        .stringValue("stringValue")
                                        .build()))
                        .messageDeduplicationId("messageDeduplicationId")
                        .messageGroupId("messageGroupId")
                        .messageStructure("messageStructure")
                        .subject("subject")
                        .build())
                .sqsParameters(SqsParametersProperty.builder()
                        .delaySeconds("delaySeconds")
                        .messageAttributes(Map.of(
                                "messageAttributesKey", MessageAttributeValueProperty.builder()
                                        .dataType("dataType")

                                        // the properties below are optional
                                        .binaryValue("binaryValue")
                                        .stringValue("stringValue")
                                        .build()))
                        .messageDeduplicationId("messageDeduplicationId")
                        .messageGroupId("messageGroupId")
                        .messageSystemAttributes(Map.of(
                                "messageSystemAttributesKey", MessageAttributeValueProperty.builder()
                                        .dataType("dataType")

                                        // the properties below are optional
                                        .binaryValue("binaryValue")
                                        .stringValue("stringValue")
                                        .build()))
                        .build())
                .stepFunctionsParameters(StepFunctionsParametersProperty.builder()
                        .invocationTimeoutSeconds("invocationTimeoutSeconds")
                        .invocationType("invocationType")
                        .name("name")
                        .traceHeader("traceHeader")
                        .build())
                .universalTargetParameters(UniversalTargetParametersProperty.builder()
                        .input("input")

                        // the properties below are optional
                        .invocationTimeoutSeconds("invocationTimeoutSeconds")
                        .build())
                .build())
        .name("name")

        // the properties below are optional
        .batchConfiguration(BatchConfigurationProperty.builder()
                .maxBatchSize(123)
                .maxBatchWindowInSeconds(123)
                .build())
        .description("description")
        .filterConfiguration(FilterConfigurationProperty.builder()
                .filters(List.of(FilterProperty.builder()
                        .pattern("pattern")
                        .scope("scope")
                        .build()))

                // the properties below are optional
                .language("language")
                .build())
        .logConfiguration(LogConfigurationProperty.builder()
                .includePayload("includePayload")
                .level("level")
                .build())
        .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                .arn("arn")
                .build())
        .pointInTimeConfiguration(PointInTimeConfigurationProperty.builder()
                .pointType("pointType")

                // the properties below are optional
                .endPoint(123)
                .startingPoint(123)
                .build())
        .resumePosition("resumePosition")
        .retryPolicy(RetryPolicyProperty.builder()
                .maxEventAgeInSeconds(123)
                .maxRetryAttempts(123)
                .retryStrategy("retryStrategy")
                .build())
        .startingPosition("startingPosition")
        .state("state")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .transformer(TransformerProperty.builder()
                .jsonataConfiguration(JsonataConfigurationProperty.builder()
                        .expression("expression")
                        .build())
                .type("type")
                .build())
        .type("type")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EventsV2;

var cfnSubscriber = new CfnSubscriber(this, "MyCfnSubscriber", new CfnSubscriberProps {
    EventBusArn = "eventBusArn",
    InvokeConfiguration = new InvokeConfigurationProperty {
        RoleArn = "roleArn",
        TargetArn = "targetArn",

        // the properties below are optional
        EventBusV2Parameters = new EventBusV2ParametersProperty {
            DeduplicationConfiguration = new DeduplicationConfigurationProperty {
                DeduplicationType = "deduplicationType"
            },
            Metadata = new Dictionary<string, string> {
                { "metadataKey", "metadata" }
            },
            SystemMetadata = new EventBusV2SystemMetadataProperty {
                DeduplicationId = "deduplicationId",
                EventGroupId = "eventGroupId"
            }
        },
        HttpParameters = new HttpParametersProperty {
            HeaderParameters = new Dictionary<string, string> {
                { "headerParametersKey", "headerParameters" }
            },
            InvocationTimeoutSeconds = "invocationTimeoutSeconds",
            PathParameterValues = new [] { "pathParameterValues" },
            QueryStringParameters = new Dictionary<string, string> {
                { "queryStringParametersKey", "queryStringParameters" }
            }
        },
        KinesisParameters = new KinesisParametersProperty {
            ExplicitHashKey = "explicitHashKey",
            PartitionKey = "partitionKey"
        },
        LambdaParameters = new LambdaParametersProperty {
            DurableExecutionName = "durableExecutionName",
            InvocationTimeoutSeconds = "invocationTimeoutSeconds",
            InvocationType = "invocationType",
            Qualifier = "qualifier",
            TenantId = "tenantId"
        },
        SnsParameters = new SnsParametersProperty {
            MessageAttributes = new Dictionary<string, object> {
                { "messageAttributesKey", new MessageAttributeValueProperty {
                    DataType = "dataType",

                    // the properties below are optional
                    BinaryValue = "binaryValue",
                    StringValue = "stringValue"
                } }
            },
            MessageDeduplicationId = "messageDeduplicationId",
            MessageGroupId = "messageGroupId",
            MessageStructure = "messageStructure",
            Subject = "subject"
        },
        SqsParameters = new SqsParametersProperty {
            DelaySeconds = "delaySeconds",
            MessageAttributes = new Dictionary<string, object> {
                { "messageAttributesKey", new MessageAttributeValueProperty {
                    DataType = "dataType",

                    // the properties below are optional
                    BinaryValue = "binaryValue",
                    StringValue = "stringValue"
                } }
            },
            MessageDeduplicationId = "messageDeduplicationId",
            MessageGroupId = "messageGroupId",
            MessageSystemAttributes = new Dictionary<string, object> {
                { "messageSystemAttributesKey", new MessageAttributeValueProperty {
                    DataType = "dataType",

                    // the properties below are optional
                    BinaryValue = "binaryValue",
                    StringValue = "stringValue"
                } }
            }
        },
        StepFunctionsParameters = new StepFunctionsParametersProperty {
            InvocationTimeoutSeconds = "invocationTimeoutSeconds",
            InvocationType = "invocationType",
            Name = "name",
            TraceHeader = "traceHeader"
        },
        UniversalTargetParameters = new UniversalTargetParametersProperty {
            Input = "input",

            // the properties below are optional
            InvocationTimeoutSeconds = "invocationTimeoutSeconds"
        }
    },
    Name = "name",

    // the properties below are optional
    BatchConfiguration = new BatchConfigurationProperty {
        MaxBatchSize = 123,
        MaxBatchWindowInSeconds = 123
    },
    Description = "description",
    FilterConfiguration = new FilterConfigurationProperty {
        Filters = new [] { new FilterProperty {
            Pattern = "pattern",
            Scope = "scope"
        } },

        // the properties below are optional
        Language = "language"
    },
    LogConfiguration = new LogConfigurationProperty {
        IncludePayload = "includePayload",
        Level = "level"
    },
    OnFailureConfiguration = new OnFailureConfigurationProperty {
        Arn = "arn"
    },
    PointInTimeConfiguration = new PointInTimeConfigurationProperty {
        PointType = "pointType",

        // the properties below are optional
        EndPoint = 123,
        StartingPoint = 123
    },
    ResumePosition = "resumePosition",
    RetryPolicy = new RetryPolicyProperty {
        MaxEventAgeInSeconds = 123,
        MaxRetryAttempts = 123,
        RetryStrategy = "retryStrategy"
    },
    StartingPosition = "startingPosition",
    State = "state",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Transformer = new TransformerProperty {
        JsonataConfiguration = new JsonataConfigurationProperty {
            Expression = "expression"
        },
        Type = "type"
    },
    Type = "type"
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnSubscriber := awscdk.Aws_eventsv2.NewCfnSubscriber(this, jsii.String("MyCfnSubscriber"), &CfnSubscriberProps{
	EventBusArn: jsii.String("eventBusArn"),
	InvokeConfiguration: &InvokeConfigurationProperty{
		RoleArn: jsii.String("roleArn"),
		TargetArn: jsii.String("targetArn"),

		// the properties below are optional
		EventBusV2Parameters: &EventBusV2ParametersProperty{
			DeduplicationConfiguration: &DeduplicationConfigurationProperty{
				DeduplicationType: jsii.String("deduplicationType"),
			},
			Metadata: map[string]*string{
				"metadataKey": jsii.String("metadata"),
			},
			SystemMetadata: &EventBusV2SystemMetadataProperty{
				DeduplicationId: jsii.String("deduplicationId"),
				EventGroupId: jsii.String("eventGroupId"),
			},
		},
		HttpParameters: &HttpParametersProperty{
			HeaderParameters: map[string]*string{
				"headerParametersKey": jsii.String("headerParameters"),
			},
			InvocationTimeoutSeconds: jsii.String("invocationTimeoutSeconds"),
			PathParameterValues: []*string{
				jsii.String("pathParameterValues"),
			},
			QueryStringParameters: map[string]*string{
				"queryStringParametersKey": jsii.String("queryStringParameters"),
			},
		},
		KinesisParameters: &KinesisParametersProperty{
			ExplicitHashKey: jsii.String("explicitHashKey"),
			PartitionKey: jsii.String("partitionKey"),
		},
		LambdaParameters: &LambdaParametersProperty{
			DurableExecutionName: jsii.String("durableExecutionName"),
			InvocationTimeoutSeconds: jsii.String("invocationTimeoutSeconds"),
			InvocationType: jsii.String("invocationType"),
			Qualifier: jsii.String("qualifier"),
			TenantId: jsii.String("tenantId"),
		},
		SnsParameters: &SnsParametersProperty{
			MessageAttributes: map[string]interface{}{
				"messageAttributesKey": &MessageAttributeValueProperty{
					"dataType": jsii.String("dataType"),

					// the properties below are optional
					"binaryValue": jsii.String("binaryValue"),
					"stringValue": jsii.String("stringValue"),
				},
			},
			MessageDeduplicationId: jsii.String("messageDeduplicationId"),
			MessageGroupId: jsii.String("messageGroupId"),
			MessageStructure: jsii.String("messageStructure"),
			Subject: jsii.String("subject"),
		},
		SqsParameters: &SqsParametersProperty{
			DelaySeconds: jsii.String("delaySeconds"),
			MessageAttributes: map[string]interface{}{
				"messageAttributesKey": &MessageAttributeValueProperty{
					"dataType": jsii.String("dataType"),

					// the properties below are optional
					"binaryValue": jsii.String("binaryValue"),
					"stringValue": jsii.String("stringValue"),
				},
			},
			MessageDeduplicationId: jsii.String("messageDeduplicationId"),
			MessageGroupId: jsii.String("messageGroupId"),
			MessageSystemAttributes: map[string]interface{}{
				"messageSystemAttributesKey": &MessageAttributeValueProperty{
					"dataType": jsii.String("dataType"),

					// the properties below are optional
					"binaryValue": jsii.String("binaryValue"),
					"stringValue": jsii.String("stringValue"),
				},
			},
		},
		StepFunctionsParameters: &StepFunctionsParametersProperty{
			InvocationTimeoutSeconds: jsii.String("invocationTimeoutSeconds"),
			InvocationType: jsii.String("invocationType"),
			Name: jsii.String("name"),
			TraceHeader: jsii.String("traceHeader"),
		},
		UniversalTargetParameters: &UniversalTargetParametersProperty{
			Input: jsii.String("input"),

			// the properties below are optional
			InvocationTimeoutSeconds: jsii.String("invocationTimeoutSeconds"),
		},
	},
	Name: jsii.String("name"),

	// the properties below are optional
	BatchConfiguration: &BatchConfigurationProperty{
		MaxBatchSize: jsii.Number(123),
		MaxBatchWindowInSeconds: jsii.Number(123),
	},
	Description: jsii.String("description"),
	FilterConfiguration: &FilterConfigurationProperty{
		Filters: []interface{}{
			&FilterProperty{
				Pattern: jsii.String("pattern"),
				Scope: jsii.String("scope"),
			},
		},

		// the properties below are optional
		Language: jsii.String("language"),
	},
	LogConfiguration: &LogConfigurationProperty{
		IncludePayload: jsii.String("includePayload"),
		Level: jsii.String("level"),
	},
	OnFailureConfiguration: &OnFailureConfigurationProperty{
		Arn: jsii.String("arn"),
	},
	PointInTimeConfiguration: &PointInTimeConfigurationProperty{
		PointType: jsii.String("pointType"),

		// the properties below are optional
		EndPoint: jsii.Number(123),
		StartingPoint: jsii.Number(123),
	},
	ResumePosition: jsii.String("resumePosition"),
	RetryPolicy: &RetryPolicyProperty{
		MaxEventAgeInSeconds: jsii.Number(123),
		MaxRetryAttempts: jsii.Number(123),
		RetryStrategy: jsii.String("retryStrategy"),
	},
	StartingPosition: jsii.String("startingPosition"),
	State: jsii.String("state"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	Transformer: &TransformerProperty{
		JsonataConfiguration: &JsonataConfigurationProperty{
			Expression: jsii.String("expression"),
		},
		Type: jsii.String("type"),
	},
	Type: jsii.String("type"),
})

Initializer

new CfnSubscriber(scope: Construct, id: string, props: CfnSubscriberProps)

CfnSubscriber(scope: Construct, id: str, props: CfnSubscriberProps)

new CfnSubscriber(Construct scope, String id, CfnSubscriberProps props)

new CfnSubscriber(Construct scope, string id, CfnSubscriberProps props)

NewCfnSubscriber(Scope Construct, Id *string, Props CfnSubscriberProps)

Construct Props

batchConfiguration?optionalIResolvable | CfnSubscriber.BatchConfigurationPropertybatch_configuration?optionaltyping.Union[IResolvable, BatchConfigurationProperty]batchConfiguration?optionalIResolvableBatchConfiguration?optionalIResolvableBatchConfiguration?optionalinterface{}#

Configuration for batching events into a single delivery.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description of the subscriber.

Control characters and Unicode line separators are not allowed.

eventBusArnstringevent_bus_arnstreventBusArnStringEventBusArnstringEventBusArn*stringrequired#

The ARN of the event bus this subscriber belongs to.

filterConfiguration?optionalIResolvable | CfnSubscriber.FilterConfigurationPropertyfilter_configuration?optionaltyping.Union[IResolvable, FilterConfigurationProperty]filterConfiguration?optionalIResolvableFilterConfiguration?optionalIResolvableFilterConfiguration?optionalinterface{}#

Configuration for filtering which events are delivered to the target.

An event must match every filter to be delivered.

invokeConfigurationIResolvable | CfnSubscriber.InvokeConfigurationPropertyinvoke_configurationtyping.Union[IResolvable, InvokeConfigurationProperty]invokeConfigurationIResolvableInvokeConfigurationIResolvableInvokeConfigurationinterface{}required#

Configuration for how the subscriber invokes its target.

Specify the target ARN, the IAM role, and, optionally, the target-specific parameters object that matches the target type.

logConfiguration?optionalIResolvable | CfnSubscriber.LogConfigurationPropertylog_configuration?optionaltyping.Union[IResolvable, LogConfigurationProperty]logConfiguration?optionalIResolvableLogConfiguration?optionalIResolvableLogConfiguration?optionalinterface{}#

Delivery logging configuration.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the subscriber.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

onFailureConfiguration?optionalIResolvable | CfnSubscriber.OnFailureConfigurationPropertyon_failure_configuration?optionaltyping.Union[IResolvable, OnFailureConfigurationProperty]onFailureConfiguration?optionalIResolvableOnFailureConfiguration?optionalIResolvableOnFailureConfiguration?optionalinterface{}#

The destination for events that could not be delivered.

pointInTimeConfiguration?optionalIResolvable | CfnSubscriber.PointInTimeConfigurationPropertypoint_in_time_configuration?optionaltyping.Union[IResolvable, PointInTimeConfigurationProperty]pointInTimeConfiguration?optionalIResolvablePointInTimeConfiguration?optionalIResolvablePointInTimeConfiguration?optionalinterface{}#

The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.

resumePosition?optionalstringresume_position?optionalstrresumePosition?optionalStringResumePosition?optionalstringResumePosition?optional*string#

Resume-time control, never returned by the service.

Applied only when an update transitions State from STOPPED to RUNNING: LAST_PROCESSED (default) resumes from the last processed event, LATEST skips to the newest. Ignored on create and on any update that does not perform that transition.

retryPolicy?optionalIResolvable | CfnSubscriber.RetryPolicyPropertyretry_policy?optionaltyping.Union[IResolvable, RetryPolicyProperty]retryPolicy?optionalIResolvableRetryPolicy?optionalIResolvableRetryPolicy?optionalinterface{}#

The retry policy for failed deliveries.

startingPosition?optionalstringstarting_position?optionalstrstartingPosition?optionalStringStartingPosition?optionalstringStartingPosition?optional*string#

Where the subscriber starts reading events: LATEST starts from the newest events;

POINT_IN_TIME starts from the point specified in PointInTimeConfiguration.

state?optionalstringstate?optionalstrstate?optionalStringState?optionalstringState?optional*string#

The run state of the subscriber.

Events are delivered only while the state is RUNNING. Setting the state to STOPPED pauses delivery. When an update sets a stopped subscriber back to RUNNING, ResumePosition controls where delivery resumes.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

The tags assigned to the subscriber.

transformer?optionalIResolvable | CfnSubscriber.TransformerPropertytransformer?optionaltyping.Union[IResolvable, TransformerProperty]transformer?optionalIResolvableTransformer?optionalIResolvableTransformer?optionalinterface{}#

Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

type?optionalstringtype?optionalstrtype?optionalStringType?optionalstringType?optional*string#

The delivery ordering mode of the subscriber.

FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Properties

attrBusNamestringattr_bus_namestrattrBusNameStringAttrBusNamestringAttrBusName*string#

The name of the event bus this subscriber belongs to.

This property is read-only.

attrCreationTimestringattr_creation_timestrattrCreationTimeStringAttrCreationTimestringAttrCreationTime*string#

Creation timestamp (ISO-8601), read-only.

attrLastModifiedTimestringattr_last_modified_timestrattrLastModifiedTimeStringAttrLastModifiedTimestringAttrLastModifiedTime*string#

Last-modification timestamp (ISO-8601), read-only.

attrSubscriberArnstringattr_subscriber_arnstrattrSubscriberArnStringAttrSubscriberArnstringAttrSubscriberArn*string#

The Amazon Resource Name (ARN) of the subscriber.

batchConfiguration?may be undefinedIResolvable | CfnSubscriber.BatchConfigurationPropertybatch_configuration?may be undefinedtyping.Union[IResolvable, BatchConfigurationProperty]batchConfiguration?may be undefinedIResolvableBatchConfiguration?may be undefinedIResolvableBatchConfiguration?may be undefinedinterface{}#

Configuration for batching events into a single delivery.

cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#

Tag Manager which manages the tags for this resource.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

description?may be undefinedstringdescription?may be undefinedstrdescription?may be undefinedStringDescription?may be undefinedstringDescription?may be undefined*string#

A description of the subscriber.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

eventBusArnstringevent_bus_arnstreventBusArnStringEventBusArnstringEventBusArn*string#

The ARN of the event bus this subscriber belongs to.

filterConfiguration?may be undefinedIResolvable | CfnSubscriber.FilterConfigurationPropertyfilter_configuration?may be undefinedtyping.Union[IResolvable, FilterConfigurationProperty]filterConfiguration?may be undefinedIResolvableFilterConfiguration?may be undefinedIResolvableFilterConfiguration?may be undefinedinterface{}#

Configuration for filtering which events are delivered to the target.

invokeConfigurationIResolvable | CfnSubscriber.InvokeConfigurationPropertyinvoke_configurationtyping.Union[IResolvable, InvokeConfigurationProperty]invokeConfigurationIResolvableInvokeConfigurationIResolvableInvokeConfigurationinterface{}#

Configuration for how the subscriber invokes its target.

logConfiguration?may be undefinedIResolvable | CfnSubscriber.LogConfigurationPropertylog_configuration?may be undefinedtyping.Union[IResolvable, LogConfigurationProperty]logConfiguration?may be undefinedIResolvableLogConfiguration?may be undefinedIResolvableLogConfiguration?may be undefinedinterface{}#

Delivery logging configuration.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

namestringnamestrnameStringNamestringName*string#

The name of the subscriber.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

onFailureConfiguration?may be undefinedIResolvable | CfnSubscriber.OnFailureConfigurationPropertyon_failure_configuration?may be undefinedtyping.Union[IResolvable, OnFailureConfigurationProperty]onFailureConfiguration?may be undefinedIResolvableOnFailureConfiguration?may be undefinedIResolvableOnFailureConfiguration?may be undefinedinterface{}#

The destination for events that could not be delivered.

pointInTimeConfiguration?may be undefinedIResolvable | CfnSubscriber.PointInTimeConfigurationPropertypoint_in_time_configuration?may be undefinedtyping.Union[IResolvable, PointInTimeConfigurationProperty]pointInTimeConfiguration?may be undefinedIResolvablePointInTimeConfiguration?may be undefinedIResolvablePointInTimeConfiguration?may be undefinedinterface{}#

The point in time to start delivering events from, used when StartingPosition is POINT_IN_TIME.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resumePosition?may be undefinedstringresume_position?may be undefinedstrresumePosition?may be undefinedStringResumePosition?may be undefinedstringResumePosition?may be undefined*string#

Resume-time control, never returned by the service.

retryPolicy?may be undefinedIResolvable | CfnSubscriber.RetryPolicyPropertyretry_policy?may be undefinedtyping.Union[IResolvable, RetryPolicyProperty]retryPolicy?may be undefinedIResolvableRetryPolicy?may be undefinedIResolvableRetryPolicy?may be undefinedinterface{}#

The retry policy for failed deliveries.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

startingPosition?may be undefinedstringstarting_position?may be undefinedstrstartingPosition?may be undefinedStringStartingPosition?may be undefinedstringStartingPosition?may be undefined*string#

Where the subscriber starts reading events: LATEST starts from the newest events;

state?may be undefinedstringstate?may be undefinedstrstate?may be undefinedStringState?may be undefinedstringState?may be undefined*string#

The run state of the subscriber.

subscriberRefSubscriberReferencesubscriber_refSubscriberReferencesubscriberRefSubscriberReferenceSubscriberRefSubscriberReferenceSubscriberRefSubscriberReference#

A reference to a Subscriber resource.

tags?may be undefinedCfnTag[]tags?may be undefinedtyping.List[CfnTag]tags?may be undefinedList<CfnTag>Tags?may be undefinedCfnTag[]Tags?may be undefined*[]CfnTag#

The tags assigned to the subscriber.

transformer?may be undefinedIResolvable | CfnSubscriber.TransformerPropertytransformer?may be undefinedtyping.Union[IResolvable, TransformerProperty]transformer?may be undefinedIResolvableTransformer?may be undefinedIResolvableTransformer?may be undefinedinterface{}#

Configuration for transforming events before delivery: the raw payload, the payload with its metadata envelope, or the output of a JSONata expression.

type?may be undefinedstringtype?may be undefinedstrtype?may be undefinedStringType?may be undefinedstringType?may be undefined*string#

The delivery ordering mode of the subscriber.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForSubscriber(resource: ISubscriberRef): string@staticmethod def arn_for_subscriber(resource: ISubscriberRef) -> strpublic static String arnForSubscriber(ISubscriberRef resource)public static string ArnForSubscriber(ISubscriberRef resource)func ArnForSubscriber(Resource ISubscriberRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isCfnSubscriber(x: any): boolean@staticmethod def is_cfn_subscriber(x: Any) -> boolpublic static Boolean isCfnSubscriber(Object x)public static bool IsCfnSubscriber(object x)func IsCfnSubscriber(X interface{}) *boolstatic#

Checks whether the given object is a CfnSubscriber.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.