CfnPipe L1 construct
Specifies a pipe.
Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see Generate an CloudFormation template from EventBridge Pipes in the Amazon EventBridge User Guide .
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const cfnPipe = new pipes.CfnPipe(this, 'MyCfnPipe', {
roleArn: 'roleArn',
source: 'source',
target: 'target',
// the properties below are optional
description: 'description',
desiredState: 'desiredState',
enrichment: 'enrichment',
enrichmentParameters: {
httpParameters: {
headerParameters: {
headerParametersKey: 'headerParameters',
},
pathParameterValues: ['pathParameterValues'],
queryStringParameters: {
queryStringParametersKey: 'queryStringParameters',
},
},
inputTemplate: 'inputTemplate',
},
kmsKeyIdentifier: 'kmsKeyIdentifier',
logConfiguration: {
cloudwatchLogsLogDestination: {
logGroupArn: 'logGroupArn',
},
firehoseLogDestination: {
deliveryStreamArn: 'deliveryStreamArn',
},
includeExecutionData: ['includeExecutionData'],
level: 'level',
s3LogDestination: {
bucketName: 'bucketName',
bucketOwner: 'bucketOwner',
outputFormat: 'outputFormat',
prefix: 'prefix',
},
},
name: 'name',
sourceParameters: {
activeMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
dynamoDbStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
},
filterCriteria: {
filters: [{
pattern: 'pattern',
}],
},
kinesisStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
startingPositionTimestamp: 'startingPositionTimestamp',
},
managedStreamingKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
startingPosition: 'startingPosition',
},
rabbitMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
virtualHost: 'virtualHost',
},
selfManagedKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
additionalBootstrapServers: ['additionalBootstrapServers'],
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
basicAuth: 'basicAuth',
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram256Auth: 'saslScram256Auth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
serverRootCaCertificate: 'serverRootCaCertificate',
startingPosition: 'startingPosition',
vpc: {
securityGroup: ['securityGroup'],
subnets: ['subnets'],
},
},
sqsQueueParameters: {
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
},
tags: {
tagsKey: 'tags',
},
targetParameters: {
batchJobParameters: {
jobDefinition: 'jobDefinition',
jobName: 'jobName',
// the properties below are optional
arrayProperties: {
size: 123,
},
containerOverrides: {
command: ['command'],
environment: [{
name: 'name',
value: 'value',
}],
instanceType: 'instanceType',
resourceRequirements: [{
type: 'type',
value: 'value',
}],
},
dependsOn: [{
jobId: 'jobId',
type: 'type',
}],
parameters: {
parametersKey: 'parameters',
},
retryStrategy: {
attempts: 123,
},
},
cloudWatchLogsParameters: {
logStreamName: 'logStreamName',
timestamp: 'timestamp',
},
ecsTaskParameters: {
taskDefinitionArn: 'taskDefinitionArn',
// the properties below are optional
capacityProviderStrategy: [{
capacityProvider: 'capacityProvider',
// the properties below are optional
base: 123,
weight: 123,
}],
enableEcsManagedTags: false,
enableExecuteCommand: false,
group: 'group',
launchType: 'launchType',
networkConfiguration: {
awsvpcConfiguration: {
subnets: ['subnets'],
// the properties below are optional
assignPublicIp: 'assignPublicIp',
securityGroups: ['securityGroups'],
},
},
overrides: {
containerOverrides: [{
command: ['command'],
cpu: 123,
environment: [{
name: 'name',
value: 'value',
}],
environmentFiles: [{
type: 'type',
value: 'value',
}],
memory: 123,
memoryReservation: 123,
name: 'name',
resourceRequirements: [{
type: 'type',
value: 'value',
}],
}],
cpu: 'cpu',
ephemeralStorage: {
sizeInGiB: 123,
},
executionRoleArn: 'executionRoleArn',
inferenceAcceleratorOverrides: [{
deviceName: 'deviceName',
deviceType: 'deviceType',
}],
memory: 'memory',
taskRoleArn: 'taskRoleArn',
},
placementConstraints: [{
expression: 'expression',
type: 'type',
}],
placementStrategy: [{
field: 'field',
type: 'type',
}],
platformVersion: 'platformVersion',
propagateTags: 'propagateTags',
referenceId: 'referenceId',
tags: [{
key: 'key',
value: 'value',
}],
taskCount: 123,
},
eventBridgeEventBusParameters: {
detailType: 'detailType',
endpointId: 'endpointId',
resources: ['resources'],
source: 'source',
time: 'time',
},
httpParameters: {
headerParameters: {
headerParametersKey: 'headerParameters',
},
pathParameterValues: ['pathParameterValues'],
queryStringParameters: {
queryStringParametersKey: 'queryStringParameters',
},
},
inputTemplate: 'inputTemplate',
kinesisStreamParameters: {
partitionKey: 'partitionKey',
},
lambdaFunctionParameters: {
invocationType: 'invocationType',
},
redshiftDataParameters: {
database: 'database',
sqls: ['sqls'],
// the properties below are optional
dbUser: 'dbUser',
secretManagerArn: 'secretManagerArn',
statementName: 'statementName',
withEvent: false,
},
sageMakerPipelineParameters: {
pipelineParameterList: [{
name: 'name',
value: 'value',
}],
},
sqsQueueParameters: {
messageDeduplicationId: 'messageDeduplicationId',
messageGroupId: 'messageGroupId',
},
stepFunctionStateMachineParameters: {
invocationType: 'invocationType',
},
timestreamParameters: {
dimensionMappings: [{
dimensionName: 'dimensionName',
dimensionValue: 'dimensionValue',
dimensionValueType: 'dimensionValueType',
}],
timeValue: 'timeValue',
versionValue: 'versionValue',
// the properties below are optional
epochTimeUnit: 'epochTimeUnit',
multiMeasureMappings: [{
multiMeasureAttributeMappings: [{
measureValue: 'measureValue',
measureValueType: 'measureValueType',
multiMeasureAttributeName: 'multiMeasureAttributeName',
}],
multiMeasureName: 'multiMeasureName',
}],
singleMeasureMappings: [{
measureName: 'measureName',
measureValue: 'measureValue',
measureValueType: 'measureValueType',
}],
timeFieldType: 'timeFieldType',
timestampFormat: 'timestampFormat',
},
},
});
python
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_pipes as pipes
cfn_pipe = pipes.CfnPipe(self, "MyCfnPipe",
role_arn="roleArn",
source="source",
target="target",
# the properties below are optional
description="description",
desired_state="desiredState",
enrichment="enrichment",
enrichment_parameters=pipes.CfnPipe.PipeEnrichmentParametersProperty(
http_parameters=pipes.CfnPipe.PipeEnrichmentHttpParametersProperty(
header_parameters={
"header_parameters_key": "headerParameters"
},
path_parameter_values=["pathParameterValues"],
query_string_parameters={
"query_string_parameters_key": "queryStringParameters"
}
),
input_template="inputTemplate"
),
kms_key_identifier="kmsKeyIdentifier",
log_configuration=pipes.CfnPipe.PipeLogConfigurationProperty(
cloudwatch_logs_log_destination=pipes.CfnPipe.CloudwatchLogsLogDestinationProperty(
log_group_arn="logGroupArn"
),
firehose_log_destination=pipes.CfnPipe.FirehoseLogDestinationProperty(
delivery_stream_arn="deliveryStreamArn"
),
include_execution_data=["includeExecutionData"],
level="level",
s3_log_destination=pipes.CfnPipe.S3LogDestinationProperty(
bucket_name="bucketName",
bucket_owner="bucketOwner",
output_format="outputFormat",
prefix="prefix"
)
),
name="name",
source_parameters=pipes.CfnPipe.PipeSourceParametersProperty(
active_mq_broker_parameters=pipes.CfnPipe.PipeSourceActiveMQBrokerParametersProperty(
credentials=pipes.CfnPipe.MQBrokerAccessCredentialsProperty(
basic_auth="basicAuth"
),
queue_name="queueName",
# the properties below are optional
batch_size=123,
maximum_batching_window_in_seconds=123
),
dynamo_db_stream_parameters=pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty(
starting_position="startingPosition",
# the properties below are optional
batch_size=123,
dead_letter_config=pipes.CfnPipe.DeadLetterConfigProperty(
arn="arn"
),
maximum_batching_window_in_seconds=123,
maximum_record_age_in_seconds=123,
maximum_retry_attempts=123,
on_partial_batch_item_failure="onPartialBatchItemFailure",
parallelization_factor=123
),
filter_criteria=pipes.CfnPipe.FilterCriteriaProperty(
filters=[pipes.CfnPipe.FilterProperty(
pattern="pattern"
)]
),
kinesis_stream_parameters=pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty(
starting_position="startingPosition",
# the properties below are optional
batch_size=123,
dead_letter_config=pipes.CfnPipe.DeadLetterConfigProperty(
arn="arn"
),
maximum_batching_window_in_seconds=123,
maximum_record_age_in_seconds=123,
maximum_retry_attempts=123,
on_partial_batch_item_failure="onPartialBatchItemFailure",
parallelization_factor=123,
starting_position_timestamp="startingPositionTimestamp"
),
managed_streaming_kafka_parameters=pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty(
topic_name="topicName",
# the properties below are optional
batch_size=123,
consumer_group_id="consumerGroupId",
credentials=pipes.CfnPipe.MSKAccessCredentialsProperty(
client_certificate_tls_auth="clientCertificateTlsAuth",
sasl_scram512_auth="saslScram512Auth"
),
maximum_batching_window_in_seconds=123,
starting_position="startingPosition"
),
rabbit_mq_broker_parameters=pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty(
credentials=pipes.CfnPipe.MQBrokerAccessCredentialsProperty(
basic_auth="basicAuth"
),
queue_name="queueName",
# the properties below are optional
batch_size=123,
maximum_batching_window_in_seconds=123,
virtual_host="virtualHost"
),
self_managed_kafka_parameters=pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty(
topic_name="topicName",
# the properties below are optional
additional_bootstrap_servers=["additionalBootstrapServers"],
batch_size=123,
consumer_group_id="consumerGroupId",
credentials=pipes.CfnPipe.SelfManagedKafkaAccessConfigurationCredentialsProperty(
basic_auth="basicAuth",
client_certificate_tls_auth="clientCertificateTlsAuth",
sasl_scram256_auth="saslScram256Auth",
sasl_scram512_auth="saslScram512Auth"
),
maximum_batching_window_in_seconds=123,
server_root_ca_certificate="serverRootCaCertificate",
starting_position="startingPosition",
vpc=pipes.CfnPipe.SelfManagedKafkaAccessConfigurationVpcProperty(
security_group=["securityGroup"],
subnets=["subnets"]
)
),
sqs_queue_parameters=pipes.CfnPipe.PipeSourceSqsQueueParametersProperty(
batch_size=123,
maximum_batching_window_in_seconds=123
)
),
tags={
"tags_key": "tags"
},
target_parameters=pipes.CfnPipe.PipeTargetParametersProperty(
batch_job_parameters=pipes.CfnPipe.PipeTargetBatchJobParametersProperty(
job_definition="jobDefinition",
job_name="jobName",
# the properties below are optional
array_properties=pipes.CfnPipe.BatchArrayPropertiesProperty(
size=123
),
container_overrides=pipes.CfnPipe.BatchContainerOverridesProperty(
command=["command"],
environment=[pipes.CfnPipe.BatchEnvironmentVariableProperty(
name="name",
value="value"
)],
instance_type="instanceType",
resource_requirements=[pipes.CfnPipe.BatchResourceRequirementProperty(
type="type",
value="value"
)]
),
depends_on=[pipes.CfnPipe.BatchJobDependencyProperty(
job_id="jobId",
type="type"
)],
parameters={
"parameters_key": "parameters"
},
retry_strategy=pipes.CfnPipe.BatchRetryStrategyProperty(
attempts=123
)
),
cloud_watch_logs_parameters=pipes.CfnPipe.PipeTargetCloudWatchLogsParametersProperty(
log_stream_name="logStreamName",
timestamp="timestamp"
),
ecs_task_parameters=pipes.CfnPipe.PipeTargetEcsTaskParametersProperty(
task_definition_arn="taskDefinitionArn",
# the properties below are optional
capacity_provider_strategy=[pipes.CfnPipe.CapacityProviderStrategyItemProperty(
capacity_provider="capacityProvider",
# the properties below are optional
base=123,
weight=123
)],
enable_ecs_managed_tags=False,
enable_execute_command=False,
group="group",
launch_type="launchType",
network_configuration=pipes.CfnPipe.NetworkConfigurationProperty(
awsvpc_configuration=pipes.CfnPipe.AwsVpcConfigurationProperty(
subnets=["subnets"],
# the properties below are optional
assign_public_ip="assignPublicIp",
security_groups=["securityGroups"]
)
),
overrides=pipes.CfnPipe.EcsTaskOverrideProperty(
container_overrides=[pipes.CfnPipe.EcsContainerOverrideProperty(
command=["command"],
cpu=123,
environment=[pipes.CfnPipe.EcsEnvironmentVariableProperty(
name="name",
value="value"
)],
environment_files=[pipes.CfnPipe.EcsEnvironmentFileProperty(
type="type",
value="value"
)],
memory=123,
memory_reservation=123,
name="name",
resource_requirements=[pipes.CfnPipe.EcsResourceRequirementProperty(
type="type",
value="value"
)]
)],
cpu="cpu",
ephemeral_storage=pipes.CfnPipe.EcsEphemeralStorageProperty(
size_in_gi_b=123
),
execution_role_arn="executionRoleArn",
inference_accelerator_overrides=[pipes.CfnPipe.EcsInferenceAcceleratorOverrideProperty(
device_name="deviceName",
device_type="deviceType"
)],
memory="memory",
task_role_arn="taskRoleArn"
),
placement_constraints=[pipes.CfnPipe.PlacementConstraintProperty(
expression="expression",
type="type"
)],
placement_strategy=[pipes.CfnPipe.PlacementStrategyProperty(
field="field",
type="type"
)],
platform_version="platformVersion",
propagate_tags="propagateTags",
reference_id="referenceId",
tags=[CfnTag(
key="key",
value="value"
)],
task_count=123
),
event_bridge_event_bus_parameters=pipes.CfnPipe.PipeTargetEventBridgeEventBusParametersProperty(
detail_type="detailType",
endpoint_id="endpointId",
resources=["resources"],
source="source",
time="time"
),
http_parameters=pipes.CfnPipe.PipeTargetHttpParametersProperty(
header_parameters={
"header_parameters_key": "headerParameters"
},
path_parameter_values=["pathParameterValues"],
query_string_parameters={
"query_string_parameters_key": "queryStringParameters"
}
),
input_template="inputTemplate",
kinesis_stream_parameters=pipes.CfnPipe.PipeTargetKinesisStreamParametersProperty(
partition_key="partitionKey"
),
lambda_function_parameters=pipes.CfnPipe.PipeTargetLambdaFunctionParametersProperty(
invocation_type="invocationType"
),
redshift_data_parameters=pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty(
database="database",
sqls=["sqls"],
# the properties below are optional
db_user="dbUser",
secret_manager_arn="secretManagerArn",
statement_name="statementName",
with_event=False
),
sage_maker_pipeline_parameters=pipes.CfnPipe.PipeTargetSageMakerPipelineParametersProperty(
pipeline_parameter_list=[pipes.CfnPipe.SageMakerPipelineParameterProperty(
name="name",
value="value"
)]
),
sqs_queue_parameters=pipes.CfnPipe.PipeTargetSqsQueueParametersProperty(
message_deduplication_id="messageDeduplicationId",
message_group_id="messageGroupId"
),
step_function_state_machine_parameters=pipes.CfnPipe.PipeTargetStateMachineParametersProperty(
invocation_type="invocationType"
),
timestream_parameters=pipes.CfnPipe.PipeTargetTimestreamParametersProperty(
dimension_mappings=[pipes.CfnPipe.DimensionMappingProperty(
dimension_name="dimensionName",
dimension_value="dimensionValue",
dimension_value_type="dimensionValueType"
)],
time_value="timeValue",
version_value="versionValue",
# the properties below are optional
epoch_time_unit="epochTimeUnit",
multi_measure_mappings=[pipes.CfnPipe.MultiMeasureMappingProperty(
multi_measure_attribute_mappings=[pipes.CfnPipe.MultiMeasureAttributeMappingProperty(
measure_value="measureValue",
measure_value_type="measureValueType",
multi_measure_attribute_name="multiMeasureAttributeName"
)],
multi_measure_name="multiMeasureName"
)],
single_measure_mappings=[pipes.CfnPipe.SingleMeasureMappingProperty(
measure_name="measureName",
measure_value="measureValue",
measure_value_type="measureValueType"
)],
time_field_type="timeFieldType",
timestamp_format="timestampFormat"
)
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pipes.*;
CfnPipe cfnPipe = CfnPipe.Builder.create(this, "MyCfnPipe")
.roleArn("roleArn")
.source("source")
.target("target")
// the properties below are optional
.description("description")
.desiredState("desiredState")
.enrichment("enrichment")
.enrichmentParameters(PipeEnrichmentParametersProperty.builder()
.httpParameters(PipeEnrichmentHttpParametersProperty.builder()
.headerParameters(Map.of(
"headerParametersKey", "headerParameters"))
.pathParameterValues(List.of("pathParameterValues"))
.queryStringParameters(Map.of(
"queryStringParametersKey", "queryStringParameters"))
.build())
.inputTemplate("inputTemplate")
.build())
.kmsKeyIdentifier("kmsKeyIdentifier")
.logConfiguration(PipeLogConfigurationProperty.builder()
.cloudwatchLogsLogDestination(CloudwatchLogsLogDestinationProperty.builder()
.logGroupArn("logGroupArn")
.build())
.firehoseLogDestination(FirehoseLogDestinationProperty.builder()
.deliveryStreamArn("deliveryStreamArn")
.build())
.includeExecutionData(List.of("includeExecutionData"))
.level("level")
.s3LogDestination(S3LogDestinationProperty.builder()
.bucketName("bucketName")
.bucketOwner("bucketOwner")
.outputFormat("outputFormat")
.prefix("prefix")
.build())
.build())
.name("name")
.sourceParameters(PipeSourceParametersProperty.builder()
.activeMqBrokerParameters(PipeSourceActiveMQBrokerParametersProperty.builder()
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.queueName("queueName")
// the properties below are optional
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.build())
.dynamoDbStreamParameters(PipeSourceDynamoDBStreamParametersProperty.builder()
.startingPosition("startingPosition")
// the properties below are optional
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.build())
.filterCriteria(FilterCriteriaProperty.builder()
.filters(List.of(FilterProperty.builder()
.pattern("pattern")
.build()))
.build())
.kinesisStreamParameters(PipeSourceKinesisStreamParametersProperty.builder()
.startingPosition("startingPosition")
// the properties below are optional
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.startingPositionTimestamp("startingPositionTimestamp")
.build())
.managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParametersProperty.builder()
.topicName("topicName")
// the properties below are optional
.batchSize(123)
.consumerGroupId("consumerGroupId")
.credentials(MSKAccessCredentialsProperty.builder()
.clientCertificateTlsAuth("clientCertificateTlsAuth")
.saslScram512Auth("saslScram512Auth")
.build())
.maximumBatchingWindowInSeconds(123)
.startingPosition("startingPosition")
.build())
.rabbitMqBrokerParameters(PipeSourceRabbitMQBrokerParametersProperty.builder()
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.queueName("queueName")
// the properties below are optional
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.virtualHost("virtualHost")
.build())
.selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParametersProperty.builder()
.topicName("topicName")
// the properties below are optional
.additionalBootstrapServers(List.of("additionalBootstrapServers"))
.batchSize(123)
.consumerGroupId("consumerGroupId")
.credentials(SelfManagedKafkaAccessConfigurationCredentialsProperty.builder()
.basicAuth("basicAuth")
.clientCertificateTlsAuth("clientCertificateTlsAuth")
.saslScram256Auth("saslScram256Auth")
.saslScram512Auth("saslScram512Auth")
.build())
.maximumBatchingWindowInSeconds(123)
.serverRootCaCertificate("serverRootCaCertificate")
.startingPosition("startingPosition")
.vpc(SelfManagedKafkaAccessConfigurationVpcProperty.builder()
.securityGroup(List.of("securityGroup"))
.subnets(List.of("subnets"))
.build())
.build())
.sqsQueueParameters(PipeSourceSqsQueueParametersProperty.builder()
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.build())
.build())
.tags(Map.of(
"tagsKey", "tags"))
.targetParameters(PipeTargetParametersProperty.builder()
.batchJobParameters(PipeTargetBatchJobParametersProperty.builder()
.jobDefinition("jobDefinition")
.jobName("jobName")
// the properties below are optional
.arrayProperties(BatchArrayPropertiesProperty.builder()
.size(123)
.build())
.containerOverrides(BatchContainerOverridesProperty.builder()
.command(List.of("command"))
.environment(List.of(BatchEnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.instanceType("instanceType")
.resourceRequirements(List.of(BatchResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.build())
.dependsOn(List.of(BatchJobDependencyProperty.builder()
.jobId("jobId")
.type("type")
.build()))
.parameters(Map.of(
"parametersKey", "parameters"))
.retryStrategy(BatchRetryStrategyProperty.builder()
.attempts(123)
.build())
.build())
.cloudWatchLogsParameters(PipeTargetCloudWatchLogsParametersProperty.builder()
.logStreamName("logStreamName")
.timestamp("timestamp")
.build())
.ecsTaskParameters(PipeTargetEcsTaskParametersProperty.builder()
.taskDefinitionArn("taskDefinitionArn")
// the properties below are optional
.capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
.capacityProvider("capacityProvider")
// the properties below are optional
.base(123)
.weight(123)
.build()))
.enableEcsManagedTags(false)
.enableExecuteCommand(false)
.group("group")
.launchType("launchType")
.networkConfiguration(NetworkConfigurationProperty.builder()
.awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
.subnets(List.of("subnets"))
// the properties below are optional
.assignPublicIp("assignPublicIp")
.securityGroups(List.of("securityGroups"))
.build())
.build())
.overrides(EcsTaskOverrideProperty.builder()
.containerOverrides(List.of(EcsContainerOverrideProperty.builder()
.command(List.of("command"))
.cpu(123)
.environment(List.of(EcsEnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.environmentFiles(List.of(EcsEnvironmentFileProperty.builder()
.type("type")
.value("value")
.build()))
.memory(123)
.memoryReservation(123)
.name("name")
.resourceRequirements(List.of(EcsResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.build()))
.cpu("cpu")
.ephemeralStorage(EcsEphemeralStorageProperty.builder()
.sizeInGiB(123)
.build())
.executionRoleArn("executionRoleArn")
.inferenceAcceleratorOverrides(List.of(EcsInferenceAcceleratorOverrideProperty.builder()
.deviceName("deviceName")
.deviceType("deviceType")
.build()))
.memory("memory")
.taskRoleArn("taskRoleArn")
.build())
.placementConstraints(List.of(PlacementConstraintProperty.builder()
.expression("expression")
.type("type")
.build()))
.placementStrategy(List.of(PlacementStrategyProperty.builder()
.field("field")
.type("type")
.build()))
.platformVersion("platformVersion")
.propagateTags("propagateTags")
.referenceId("referenceId")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.taskCount(123)
.build())
.eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParametersProperty.builder()
.detailType("detailType")
.endpointId("endpointId")
.resources(List.of("resources"))
.source("source")
.time("time")
.build())
.httpParameters(PipeTargetHttpParametersProperty.builder()
.headerParameters(Map.of(
"headerParametersKey", "headerParameters"))
.pathParameterValues(List.of("pathParameterValues"))
.queryStringParameters(Map.of(
"queryStringParametersKey", "queryStringParameters"))
.build())
.inputTemplate("inputTemplate")
.kinesisStreamParameters(PipeTargetKinesisStreamParametersProperty.builder()
.partitionKey("partitionKey")
.build())
.lambdaFunctionParameters(PipeTargetLambdaFunctionParametersProperty.builder()
.invocationType("invocationType")
.build())
.redshiftDataParameters(PipeTargetRedshiftDataParametersProperty.builder()
.database("database")
.sqls(List.of("sqls"))
// the properties below are optional
.dbUser("dbUser")
.secretManagerArn("secretManagerArn")
.statementName("statementName")
.withEvent(false)
.build())
.sageMakerPipelineParameters(PipeTargetSageMakerPipelineParametersProperty.builder()
.pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.sqsQueueParameters(PipeTargetSqsQueueParametersProperty.builder()
.messageDeduplicationId("messageDeduplicationId")
.messageGroupId("messageGroupId")
.build())
.stepFunctionStateMachineParameters(PipeTargetStateMachineParametersProperty.builder()
.invocationType("invocationType")
.build())
.timestreamParameters(PipeTargetTimestreamParametersProperty.builder()
.dimensionMappings(List.of(DimensionMappingProperty.builder()
.dimensionName("dimensionName")
.dimensionValue("dimensionValue")
.dimensionValueType("dimensionValueType")
.build()))
.timeValue("timeValue")
.versionValue("versionValue")
// the properties below are optional
.epochTimeUnit("epochTimeUnit")
.multiMeasureMappings(List.of(MultiMeasureMappingProperty.builder()
.multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
.measureValue("measureValue")
.measureValueType("measureValueType")
.multiMeasureAttributeName("multiMeasureAttributeName")
.build()))
.multiMeasureName("multiMeasureName")
.build()))
.singleMeasureMappings(List.of(SingleMeasureMappingProperty.builder()
.measureName("measureName")
.measureValue("measureValue")
.measureValueType("measureValueType")
.build()))
.timeFieldType("timeFieldType")
.timestampFormat("timestampFormat")
.build())
.build())
.build();
csharp
// 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.Pipes;
var cfnPipe = new CfnPipe(this, "MyCfnPipe", new CfnPipeProps {
RoleArn = "roleArn",
Source = "source",
Target = "target",
// the properties below are optional
Description = "description",
DesiredState = "desiredState",
Enrichment = "enrichment",
EnrichmentParameters = new PipeEnrichmentParametersProperty {
HttpParameters = new PipeEnrichmentHttpParametersProperty {
HeaderParameters = new Dictionary<string, string> {
{ "headerParametersKey", "headerParameters" }
},
PathParameterValues = new [] { "pathParameterValues" },
QueryStringParameters = new Dictionary<string, string> {
{ "queryStringParametersKey", "queryStringParameters" }
}
},
InputTemplate = "inputTemplate"
},
KmsKeyIdentifier = "kmsKeyIdentifier",
LogConfiguration = new PipeLogConfigurationProperty {
CloudwatchLogsLogDestination = new CloudwatchLogsLogDestinationProperty {
LogGroupArn = "logGroupArn"
},
FirehoseLogDestination = new FirehoseLogDestinationProperty {
DeliveryStreamArn = "deliveryStreamArn"
},
IncludeExecutionData = new [] { "includeExecutionData" },
Level = "level",
S3LogDestination = new S3LogDestinationProperty {
BucketName = "bucketName",
BucketOwner = "bucketOwner",
OutputFormat = "outputFormat",
Prefix = "prefix"
}
},
Name = "name",
SourceParameters = new PipeSourceParametersProperty {
ActiveMqBrokerParameters = new PipeSourceActiveMQBrokerParametersProperty {
Credentials = new MQBrokerAccessCredentialsProperty {
BasicAuth = "basicAuth"
},
QueueName = "queueName",
// the properties below are optional
BatchSize = 123,
MaximumBatchingWindowInSeconds = 123
},
DynamoDbStreamParameters = new PipeSourceDynamoDBStreamParametersProperty {
StartingPosition = "startingPosition",
// the properties below are optional
BatchSize = 123,
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
MaximumBatchingWindowInSeconds = 123,
MaximumRecordAgeInSeconds = 123,
MaximumRetryAttempts = 123,
OnPartialBatchItemFailure = "onPartialBatchItemFailure",
ParallelizationFactor = 123
},
FilterCriteria = new FilterCriteriaProperty {
Filters = new [] { new FilterProperty {
Pattern = "pattern"
} }
},
KinesisStreamParameters = new PipeSourceKinesisStreamParametersProperty {
StartingPosition = "startingPosition",
// the properties below are optional
BatchSize = 123,
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
MaximumBatchingWindowInSeconds = 123,
MaximumRecordAgeInSeconds = 123,
MaximumRetryAttempts = 123,
OnPartialBatchItemFailure = "onPartialBatchItemFailure",
ParallelizationFactor = 123,
StartingPositionTimestamp = "startingPositionTimestamp"
},
ManagedStreamingKafkaParameters = new PipeSourceManagedStreamingKafkaParametersProperty {
TopicName = "topicName",
// the properties below are optional
BatchSize = 123,
ConsumerGroupId = "consumerGroupId",
Credentials = new MSKAccessCredentialsProperty {
ClientCertificateTlsAuth = "clientCertificateTlsAuth",
SaslScram512Auth = "saslScram512Auth"
},
MaximumBatchingWindowInSeconds = 123,
StartingPosition = "startingPosition"
},
RabbitMqBrokerParameters = new PipeSourceRabbitMQBrokerParametersProperty {
Credentials = new MQBrokerAccessCredentialsProperty {
BasicAuth = "basicAuth"
},
QueueName = "queueName",
// the properties below are optional
BatchSize = 123,
MaximumBatchingWindowInSeconds = 123,
VirtualHost = "virtualHost"
},
SelfManagedKafkaParameters = new PipeSourceSelfManagedKafkaParametersProperty {
TopicName = "topicName",
// the properties below are optional
AdditionalBootstrapServers = new [] { "additionalBootstrapServers" },
BatchSize = 123,
ConsumerGroupId = "consumerGroupId",
Credentials = new SelfManagedKafkaAccessConfigurationCredentialsProperty {
BasicAuth = "basicAuth",
ClientCertificateTlsAuth = "clientCertificateTlsAuth",
SaslScram256Auth = "saslScram256Auth",
SaslScram512Auth = "saslScram512Auth"
},
MaximumBatchingWindowInSeconds = 123,
ServerRootCaCertificate = "serverRootCaCertificate",
StartingPosition = "startingPosition",
Vpc = new SelfManagedKafkaAccessConfigurationVpcProperty {
SecurityGroup = new [] { "securityGroup" },
Subnets = new [] { "subnets" }
}
},
SqsQueueParameters = new PipeSourceSqsQueueParametersProperty {
BatchSize = 123,
MaximumBatchingWindowInSeconds = 123
}
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TargetParameters = new PipeTargetParametersProperty {
BatchJobParameters = new PipeTargetBatchJobParametersProperty {
JobDefinition = "jobDefinition",
JobName = "jobName",
// the properties below are optional
ArrayProperties = new BatchArrayPropertiesProperty {
Size = 123
},
ContainerOverrides = new BatchContainerOverridesProperty {
Command = new [] { "command" },
Environment = new [] { new BatchEnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
InstanceType = "instanceType",
ResourceRequirements = new [] { new BatchResourceRequirementProperty {
Type = "type",
Value = "value"
} }
},
DependsOn = new [] { new BatchJobDependencyProperty {
JobId = "jobId",
Type = "type"
} },
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RetryStrategy = new BatchRetryStrategyProperty {
Attempts = 123
}
},
CloudWatchLogsParameters = new PipeTargetCloudWatchLogsParametersProperty {
LogStreamName = "logStreamName",
Timestamp = "timestamp"
},
EcsTaskParameters = new PipeTargetEcsTaskParametersProperty {
TaskDefinitionArn = "taskDefinitionArn",
// the properties below are optional
CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
EnableEcsManagedTags = false,
EnableExecuteCommand = false,
Group = "group",
LaunchType = "launchType",
NetworkConfiguration = new NetworkConfigurationProperty {
AwsvpcConfiguration = new AwsVpcConfigurationProperty {
Subnets = new [] { "subnets" },
// the properties below are optional
AssignPublicIp = "assignPublicIp",
SecurityGroups = new [] { "securityGroups" }
}
},
Overrides = new EcsTaskOverrideProperty {
ContainerOverrides = new [] { new EcsContainerOverrideProperty {
Command = new [] { "command" },
Cpu = 123,
Environment = new [] { new EcsEnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
EnvironmentFiles = new [] { new EcsEnvironmentFileProperty {
Type = "type",
Value = "value"
} },
Memory = 123,
MemoryReservation = 123,
Name = "name",
ResourceRequirements = new [] { new EcsResourceRequirementProperty {
Type = "type",
Value = "value"
} }
} },
Cpu = "cpu",
EphemeralStorage = new EcsEphemeralStorageProperty {
SizeInGiB = 123
},
ExecutionRoleArn = "executionRoleArn",
InferenceAcceleratorOverrides = new [] { new EcsInferenceAcceleratorOverrideProperty {
DeviceName = "deviceName",
DeviceType = "deviceType"
} },
Memory = "memory",
TaskRoleArn = "taskRoleArn"
},
PlacementConstraints = new [] { new PlacementConstraintProperty {
Expression = "expression",
Type = "type"
} },
PlacementStrategy = new [] { new PlacementStrategyProperty {
Field = "field",
Type = "type"
} },
PlatformVersion = "platformVersion",
PropagateTags = "propagateTags",
ReferenceId = "referenceId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TaskCount = 123
},
EventBridgeEventBusParameters = new PipeTargetEventBridgeEventBusParametersProperty {
DetailType = "detailType",
EndpointId = "endpointId",
Resources = new [] { "resources" },
Source = "source",
Time = "time"
},
HttpParameters = new PipeTargetHttpParametersProperty {
HeaderParameters = new Dictionary<string, string> {
{ "headerParametersKey", "headerParameters" }
},
PathParameterValues = new [] { "pathParameterValues" },
QueryStringParameters = new Dictionary<string, string> {
{ "queryStringParametersKey", "queryStringParameters" }
}
},
InputTemplate = "inputTemplate",
KinesisStreamParameters = new PipeTargetKinesisStreamParametersProperty {
PartitionKey = "partitionKey"
},
LambdaFunctionParameters = new PipeTargetLambdaFunctionParametersProperty {
InvocationType = "invocationType"
},
RedshiftDataParameters = new PipeTargetRedshiftDataParametersProperty {
Database = "database",
Sqls = new [] { "sqls" },
// the properties below are optional
DbUser = "dbUser",
SecretManagerArn = "secretManagerArn",
StatementName = "statementName",
WithEvent = false
},
SageMakerPipelineParameters = new PipeTargetSageMakerPipelineParametersProperty {
PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
Name = "name",
Value = "value"
} }
},
SqsQueueParameters = new PipeTargetSqsQueueParametersProperty {
MessageDeduplicationId = "messageDeduplicationId",
MessageGroupId = "messageGroupId"
},
StepFunctionStateMachineParameters = new PipeTargetStateMachineParametersProperty {
InvocationType = "invocationType"
},
TimestreamParameters = new PipeTargetTimestreamParametersProperty {
DimensionMappings = new [] { new DimensionMappingProperty {
DimensionName = "dimensionName",
DimensionValue = "dimensionValue",
DimensionValueType = "dimensionValueType"
} },
TimeValue = "timeValue",
VersionValue = "versionValue",
// the properties below are optional
EpochTimeUnit = "epochTimeUnit",
MultiMeasureMappings = new [] { new MultiMeasureMappingProperty {
MultiMeasureAttributeMappings = new [] { new MultiMeasureAttributeMappingProperty {
MeasureValue = "measureValue",
MeasureValueType = "measureValueType",
MultiMeasureAttributeName = "multiMeasureAttributeName"
} },
MultiMeasureName = "multiMeasureName"
} },
SingleMeasureMappings = new [] { new SingleMeasureMappingProperty {
MeasureName = "measureName",
MeasureValue = "measureValue",
MeasureValueType = "measureValueType"
} },
TimeFieldType = "timeFieldType",
TimestampFormat = "timestampFormat"
}
}
});
go
// 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"
cfnPipe := awscdk.Aws_pipes.NewCfnPipe(this, jsii.String("MyCfnPipe"), &CfnPipeProps{
RoleArn: jsii.String("roleArn"),
Source: jsii.String("source"),
Target: jsii.String("target"),
// the properties below are optional
Description: jsii.String("description"),
DesiredState: jsii.String("desiredState"),
Enrichment: jsii.String("enrichment"),
EnrichmentParameters: &PipeEnrichmentParametersProperty{
HttpParameters: &PipeEnrichmentHttpParametersProperty{
HeaderParameters: map[string]*string{
"headerParametersKey": jsii.String("headerParameters"),
},
PathParameterValues: []*string{
jsii.String("pathParameterValues"),
},
QueryStringParameters: map[string]*string{
"queryStringParametersKey": jsii.String("queryStringParameters"),
},
},
InputTemplate: jsii.String("inputTemplate"),
},
KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"),
LogConfiguration: &PipeLogConfigurationProperty{
CloudwatchLogsLogDestination: &CloudwatchLogsLogDestinationProperty{
LogGroupArn: jsii.String("logGroupArn"),
},
FirehoseLogDestination: &FirehoseLogDestinationProperty{
DeliveryStreamArn: jsii.String("deliveryStreamArn"),
},
IncludeExecutionData: []*string{
jsii.String("includeExecutionData"),
},
Level: jsii.String("level"),
S3LogDestination: &S3LogDestinationProperty{
BucketName: jsii.String("bucketName"),
BucketOwner: jsii.String("bucketOwner"),
OutputFormat: jsii.String("outputFormat"),
Prefix: jsii.String("prefix"),
},
},
Name: jsii.String("name"),
SourceParameters: &PipeSourceParametersProperty{
ActiveMqBrokerParameters: &PipeSourceActiveMQBrokerParametersProperty{
Credentials: &MQBrokerAccessCredentialsProperty{
BasicAuth: jsii.String("basicAuth"),
},
QueueName: jsii.String("queueName"),
// the properties below are optional
BatchSize: jsii.Number(123),
MaximumBatchingWindowInSeconds: jsii.Number(123),
},
DynamoDbStreamParameters: &PipeSourceDynamoDBStreamParametersProperty{
StartingPosition: jsii.String("startingPosition"),
// the properties below are optional
BatchSize: jsii.Number(123),
DeadLetterConfig: &DeadLetterConfigProperty{
Arn: jsii.String("arn"),
},
MaximumBatchingWindowInSeconds: jsii.Number(123),
MaximumRecordAgeInSeconds: jsii.Number(123),
MaximumRetryAttempts: jsii.Number(123),
OnPartialBatchItemFailure: jsii.String("onPartialBatchItemFailure"),
ParallelizationFactor: jsii.Number(123),
},
FilterCriteria: &FilterCriteriaProperty{
Filters: []interface{}{
&FilterProperty{
Pattern: jsii.String("pattern"),
},
},
},
KinesisStreamParameters: &PipeSourceKinesisStreamParametersProperty{
StartingPosition: jsii.String("startingPosition"),
// the properties below are optional
BatchSize: jsii.Number(123),
DeadLetterConfig: &DeadLetterConfigProperty{
Arn: jsii.String("arn"),
},
MaximumBatchingWindowInSeconds: jsii.Number(123),
MaximumRecordAgeInSeconds: jsii.Number(123),
MaximumRetryAttempts: jsii.Number(123),
OnPartialBatchItemFailure: jsii.String("onPartialBatchItemFailure"),
ParallelizationFactor: jsii.Number(123),
StartingPositionTimestamp: jsii.String("startingPositionTimestamp"),
},
ManagedStreamingKafkaParameters: &PipeSourceManagedStreamingKafkaParametersProperty{
TopicName: jsii.String("topicName"),
// the properties below are optional
BatchSize: jsii.Number(123),
ConsumerGroupId: jsii.String("consumerGroupId"),
Credentials: &MSKAccessCredentialsProperty{
ClientCertificateTlsAuth: jsii.String("clientCertificateTlsAuth"),
SaslScram512Auth: jsii.String("saslScram512Auth"),
},
MaximumBatchingWindowInSeconds: jsii.Number(123),
StartingPosition: jsii.String("startingPosition"),
},
RabbitMqBrokerParameters: &PipeSourceRabbitMQBrokerParametersProperty{
Credentials: &MQBrokerAccessCredentialsProperty{
BasicAuth: jsii.String("basicAuth"),
},
QueueName: jsii.String("queueName"),
// the properties below are optional
BatchSize: jsii.Number(123),
MaximumBatchingWindowInSeconds: jsii.Number(123),
VirtualHost: jsii.String("virtualHost"),
},
SelfManagedKafkaParameters: &PipeSourceSelfManagedKafkaParametersProperty{
TopicName: jsii.String("topicName"),
// the properties below are optional
AdditionalBootstrapServers: []*string{
jsii.String("additionalBootstrapServers"),
},
BatchSize: jsii.Number(123),
ConsumerGroupId: jsii.String("consumerGroupId"),
Credentials: &SelfManagedKafkaAccessConfigurationCredentialsProperty{
BasicAuth: jsii.String("basicAuth"),
ClientCertificateTlsAuth: jsii.String("clientCertificateTlsAuth"),
SaslScram256Auth: jsii.String("saslScram256Auth"),
SaslScram512Auth: jsii.String("saslScram512Auth"),
},
MaximumBatchingWindowInSeconds: jsii.Number(123),
ServerRootCaCertificate: jsii.String("serverRootCaCertificate"),
StartingPosition: jsii.String("startingPosition"),
Vpc: &SelfManagedKafkaAccessConfigurationVpcProperty{
SecurityGroup: []*string{
jsii.String("securityGroup"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
SqsQueueParameters: &PipeSourceSqsQueueParametersProperty{
BatchSize: jsii.Number(123),
MaximumBatchingWindowInSeconds: jsii.Number(123),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
TargetParameters: &PipeTargetParametersProperty{
BatchJobParameters: &PipeTargetBatchJobParametersProperty{
JobDefinition: jsii.String("jobDefinition"),
JobName: jsii.String("jobName"),
// the properties below are optional
ArrayProperties: &BatchArrayPropertiesProperty{
Size: jsii.Number(123),
},
ContainerOverrides: &BatchContainerOverridesProperty{
Command: []*string{
jsii.String("command"),
},
Environment: []interface{}{
&BatchEnvironmentVariableProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
InstanceType: jsii.String("instanceType"),
ResourceRequirements: []interface{}{
&BatchResourceRequirementProperty{
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
},
DependsOn: []interface{}{
&BatchJobDependencyProperty{
JobId: jsii.String("jobId"),
Type: jsii.String("type"),
},
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
RetryStrategy: &BatchRetryStrategyProperty{
Attempts: jsii.Number(123),
},
},
CloudWatchLogsParameters: &PipeTargetCloudWatchLogsParametersProperty{
LogStreamName: jsii.String("logStreamName"),
Timestamp: jsii.String("timestamp"),
},
EcsTaskParameters: &PipeTargetEcsTaskParametersProperty{
TaskDefinitionArn: jsii.String("taskDefinitionArn"),
// the properties below are optional
CapacityProviderStrategy: []interface{}{
&CapacityProviderStrategyItemProperty{
CapacityProvider: jsii.String("capacityProvider"),
// the properties below are optional
Base: jsii.Number(123),
Weight: jsii.Number(123),
},
},
EnableEcsManagedTags: jsii.Boolean(false),
EnableExecuteCommand: jsii.Boolean(false),
Group: jsii.String("group"),
LaunchType: jsii.String("launchType"),
NetworkConfiguration: &NetworkConfigurationProperty{
AwsvpcConfiguration: &AwsVpcConfigurationProperty{
Subnets: []*string{
jsii.String("subnets"),
},
// the properties below are optional
AssignPublicIp: jsii.String("assignPublicIp"),
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
},
},
Overrides: &EcsTaskOverrideProperty{
ContainerOverrides: []interface{}{
&EcsContainerOverrideProperty{
Command: []*string{
jsii.String("command"),
},
Cpu: jsii.Number(123),
Environment: []interface{}{
&EcsEnvironmentVariableProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
EnvironmentFiles: []interface{}{
&EcsEnvironmentFileProperty{
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
Memory: jsii.Number(123),
MemoryReservation: jsii.Number(123),
Name: jsii.String("name"),
ResourceRequirements: []interface{}{
&EcsResourceRequirementProperty{
Type: jsii.String("type"),
Value: jsii.String("value"),
},
},
},
},
Cpu: jsii.String("cpu"),
EphemeralStorage: &EcsEphemeralStorageProperty{
SizeInGiB: jsii.Number(123),
},
ExecutionRoleArn: jsii.String("executionRoleArn"),
InferenceAcceleratorOverrides: []interface{}{
&EcsInferenceAcceleratorOverrideProperty{
DeviceName: jsii.String("deviceName"),
DeviceType: jsii.String("deviceType"),
},
},
Memory: jsii.String("memory"),
TaskRoleArn: jsii.String("taskRoleArn"),
},
PlacementConstraints: []interface{}{
&PlacementConstraintProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
PlacementStrategy: []interface{}{
&PlacementStrategyProperty{
Field: jsii.String("field"),
Type: jsii.String("type"),
},
},
PlatformVersion: jsii.String("platformVersion"),
PropagateTags: jsii.String("propagateTags"),
ReferenceId: jsii.String("referenceId"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TaskCount: jsii.Number(123),
},
EventBridgeEventBusParameters: &PipeTargetEventBridgeEventBusParametersProperty{
DetailType: jsii.String("detailType"),
EndpointId: jsii.String("endpointId"),
Resources: []*string{
jsii.String("resources"),
},
Source: jsii.String("source"),
Time: jsii.String("time"),
},
HttpParameters: &PipeTargetHttpParametersProperty{
HeaderParameters: map[string]*string{
"headerParametersKey": jsii.String("headerParameters"),
},
PathParameterValues: []*string{
jsii.String("pathParameterValues"),
},
QueryStringParameters: map[string]*string{
"queryStringParametersKey": jsii.String("queryStringParameters"),
},
},
InputTemplate: jsii.String("inputTemplate"),
KinesisStreamParameters: &PipeTargetKinesisStreamParametersProperty{
PartitionKey: jsii.String("partitionKey"),
},
LambdaFunctionParameters: &PipeTargetLambdaFunctionParametersProperty{
InvocationType: jsii.String("invocationType"),
},
RedshiftDataParameters: &PipeTargetRedshiftDataParametersProperty{
Database: jsii.String("database"),
Sqls: []*string{
jsii.String("sqls"),
},
// the properties below are optional
DbUser: jsii.String("dbUser"),
SecretManagerArn: jsii.String("secretManagerArn"),
StatementName: jsii.String("statementName"),
WithEvent: jsii.Boolean(false),
},
SageMakerPipelineParameters: &PipeTargetSageMakerPipelineParametersProperty{
PipelineParameterList: []interface{}{
&SageMakerPipelineParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
SqsQueueParameters: &PipeTargetSqsQueueParametersProperty{
MessageDeduplicationId: jsii.String("messageDeduplicationId"),
MessageGroupId: jsii.String("messageGroupId"),
},
StepFunctionStateMachineParameters: &PipeTargetStateMachineParametersProperty{
InvocationType: jsii.String("invocationType"),
},
TimestreamParameters: &PipeTargetTimestreamParametersProperty{
DimensionMappings: []interface{}{
&DimensionMappingProperty{
DimensionName: jsii.String("dimensionName"),
DimensionValue: jsii.String("dimensionValue"),
DimensionValueType: jsii.String("dimensionValueType"),
},
},
TimeValue: jsii.String("timeValue"),
VersionValue: jsii.String("versionValue"),
// the properties below are optional
EpochTimeUnit: jsii.String("epochTimeUnit"),
MultiMeasureMappings: []interface{}{
&MultiMeasureMappingProperty{
MultiMeasureAttributeMappings: []interface{}{
&MultiMeasureAttributeMappingProperty{
MeasureValue: jsii.String("measureValue"),
MeasureValueType: jsii.String("measureValueType"),
MultiMeasureAttributeName: jsii.String("multiMeasureAttributeName"),
},
},
MultiMeasureName: jsii.String("multiMeasureName"),
},
},
SingleMeasureMappings: []interface{}{
&SingleMeasureMappingProperty{
MeasureName: jsii.String("measureName"),
MeasureValue: jsii.String("measureValue"),
MeasureValueType: jsii.String("measureValueType"),
},
},
TimeFieldType: jsii.String("timeFieldType"),
TimestampFormat: jsii.String("timestampFormat"),
},
},
})
Initializer
ts
new CfnPipe(scope: Construct, id: string, props: CfnPipeProps)
python
CfnPipe(scope: Construct, id: str, props: CfnPipeProps)
java
new CfnPipe(Construct scope, String id, CfnPipeProps props)
csharp
new CfnPipe(Construct scope, string id, CfnPipeProps props)
go
NewCfnPipe(Scope Construct, Id *string, Props CfnPipeProps)
Construct Props
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the pipe.
desiredStateoptionalstringdesired_stateoptionalstrdesiredStateoptionalStringDesiredStateoptionalstringDesiredStateoptional*string#The state the pipe should be in.
enrichmentoptionalstring | IFunctionRefenrichmentoptionaltyping.Union[str, IFunctionRef]enrichmentoptionalStringEnrichmentoptionalstringEnrichmentoptionalinterface{}#The ARN of the enrichment resource.
enrichmentParametersoptionalIResolvable | CfnPipe.PipeEnrichmentParametersPropertyenrichment_parametersoptionaltyping.Union[IResolvable, PipeEnrichmentParametersProperty]enrichmentParametersoptionalIResolvableEnrichmentParametersoptionalIResolvableEnrichmentParametersoptionalinterface{}#The parameters required to set up enrichment on your pipe.
kmsKeyIdentifieroptionalstringkms_key_identifieroptionalstrkmsKeyIdentifieroptionalStringKmsKeyIdentifieroptionalstringKmsKeyIdentifieroptional*string#The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
notes
The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
logConfigurationoptionalIResolvable | CfnPipe.PipeLogConfigurationPropertylog_configurationoptionaltyping.Union[IResolvable, PipeLogConfigurationProperty]logConfigurationoptionalIResolvableLogConfigurationoptionalIResolvableLogConfigurationoptionalinterface{}#The logging configuration settings for the pipe.
The name of the pipe.
roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#The ARN of the role that allows the pipe to send data to the target.
sourcestring | IStreamRef | IQueueRefsourcetyping.Union[str, IStreamRef, IQueueRef]sourceStringSourcestringSourceinterface{}required#The ARN of the source resource.
sourceParametersoptionalIResolvable | CfnPipe.PipeSourceParametersPropertysource_parametersoptionaltyping.Union[IResolvable, PipeSourceParametersProperty]sourceParametersoptionalIResolvableSourceParametersoptionalIResolvableSourceParametersoptionalinterface{}#The parameters required to set up a source for your pipe.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#The list of key-value pairs to associate with the pipe.
targetstring | IEventBusRef | IFunctionRef | ILogGroupRef | ITopicRef | IQueueRef | IStateMachineReftargettyping.Union[str, IEventBusRef, IFunctionRef, ILogGroupRef, ITopicRef, IQueueRef, IStateMachineRef]targetStringTargetstringTargetinterface{}required#The ARN of the target resource.
targetParametersoptionalIResolvable | CfnPipe.PipeTargetParametersPropertytarget_parametersoptionaltyping.Union[IResolvable, PipeTargetParametersProperty]targetParametersoptionalIResolvableTargetParametersoptionalIResolvableTargetParametersoptionalinterface{}#The parameters required to set up a target for your pipe.
notes
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .
Properties
The ARN of the pipe.
attrCreationTimestringattr_creation_timestrattrCreationTimeStringAttrCreationTimestringAttrCreationTime*stringrequired#The time the pipe was created.
attrCurrentStatestringattr_current_statestrattrCurrentStateStringAttrCurrentStatestringAttrCurrentState*stringrequired#The state the pipe is in.
attrLastModifiedTimestringattr_last_modified_timestrattrLastModifiedTimeStringAttrLastModifiedTimestringAttrLastModifiedTime*stringrequired#When the pipe was last updated, in [ISO-8601 format](https://docs.aws.amazon.com/https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).
attrStateReasonstringattr_state_reasonstrattrStateReasonStringAttrStateReasonstringAttrStateReason*stringrequired#The reason the pipe is in its current state.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#A description of the pipe.
desiredStatemay be undefinedstringdesired_statemay be undefinedstrdesiredStatemay be undefinedStringDesiredStatemay be undefinedstringDesiredStatemay be undefined*string#The state the pipe should be in.
enrichmentmay be undefinedstringenrichmentmay be undefinedstrenrichmentmay be undefinedStringEnrichmentmay be undefinedstringEnrichmentmay be undefined*string#The ARN of the enrichment resource.
enrichmentParametersmay be undefinedIResolvable | CfnPipe.PipeEnrichmentParametersPropertyenrichment_parametersmay be undefinedtyping.Union[IResolvable, PipeEnrichmentParametersProperty]enrichmentParametersmay be undefinedIResolvableEnrichmentParametersmay be undefinedIResolvableEnrichmentParametersmay be undefinedinterface{}#The parameters required to set up enrichment on your pipe.
kmsKeyIdentifiermay be undefinedstringkms_key_identifiermay be undefinedstrkmsKeyIdentifiermay be undefinedStringKmsKeyIdentifiermay be undefinedstringKmsKeyIdentifiermay be undefined*string#The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
logConfigurationmay be undefinedIResolvable | CfnPipe.PipeLogConfigurationPropertylog_configurationmay be undefinedtyping.Union[IResolvable, PipeLogConfigurationProperty]logConfigurationmay be undefinedIResolvableLogConfigurationmay be undefinedIResolvableLogConfigurationmay be undefinedinterface{}#The logging configuration settings for the pipe.
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).
namemay be undefinedstringnamemay be undefinedstrnamemay be undefinedStringNamemay be undefinedstringNamemay be undefined*string#The name of the pipe.
pipeRefPipeReferencepipe_refPipeReferencepipeRefPipeReferencePipeRefPipeReferencePipeRefPipeReferencerequired#A reference to a Pipe resource.
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 }).
The ARN of the role that allows the pipe to send data to the target.
The ARN of the source resource.
sourceParametersmay be undefinedIResolvable | CfnPipe.PipeSourceParametersPropertysource_parametersmay be undefinedtyping.Union[IResolvable, PipeSourceParametersProperty]sourceParametersmay be undefinedIResolvableSourceParametersmay be undefinedIResolvableSourceParametersmay be undefinedinterface{}#The parameters required to set up a source for your pipe.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Tag Manager which manages the tags for this resource.
tagsRawmay be undefined{ [key: string]: string }tags_rawmay be undefinedtyping.Mapping[str, str]tagsRawmay be undefinedMap<String, String>TagsRawmay be undefinedIDictionary<string, string>TagsRawmay be undefined*map[string]*string#The list of key-value pairs to associate with the pipe.
The ARN of the target resource.
targetParametersmay be undefinedIResolvable | CfnPipe.PipeTargetParametersPropertytarget_parametersmay be undefinedtyping.Union[IResolvable, PipeTargetParametersProperty]targetParametersmay be undefinedIResolvableTargetParametersmay be undefinedIResolvableTargetParametersmay be undefinedinterface{}#The parameters required to set up a target for your pipe.
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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:
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.
isCfnPipe(x: any): boolean@staticmethod def is_cfn_pipe(x: Any) -> boolpublic static Boolean isCfnPipe(Object x)public static bool IsCfnPipe(object x)func IsCfnPipe(X interface{}) *boolstatic#Checks whether the given object is a CfnPipe.
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.
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.