software.amazon.awscdk.services.events

Interface CfnRule.TargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.TargetProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(value=Stable)
public static interface CfnRule.TargetProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 TargetProperty targetProperty = TargetProperty.builder()
         .arn("arn")
         .id("id")
         // the properties below are optional
         .batchParameters(BatchParametersProperty.builder()
                 .jobDefinition("jobDefinition")
                 .jobName("jobName")
                 // the properties below are optional
                 .arrayProperties(BatchArrayPropertiesProperty.builder()
                         .size(123)
                         .build())
                 .retryStrategy(BatchRetryStrategyProperty.builder()
                         .attempts(123)
                         .build())
                 .build())
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .ecsParameters(EcsParametersProperty.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())
                 .placementConstraints(List.of(PlacementConstraintProperty.builder()
                         .expression("expression")
                         .type("type")
                         .build()))
                 .placementStrategies(List.of(PlacementStrategyProperty.builder()
                         .field("field")
                         .type("type")
                         .build()))
                 .platformVersion("platformVersion")
                 .propagateTags("propagateTags")
                 .referenceId("referenceId")
                 .tagList(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .taskCount(123)
                 .build())
         .httpParameters(HttpParametersProperty.builder()
                 .headerParameters(Map.of(
                         "headerParametersKey", "headerParameters"))
                 .pathParameterValues(List.of("pathParameterValues"))
                 .queryStringParameters(Map.of(
                         "queryStringParametersKey", "queryStringParameters"))
                 .build())
         .input("input")
         .inputPath("inputPath")
         .inputTransformer(InputTransformerProperty.builder()
                 .inputTemplate("inputTemplate")
                 // the properties below are optional
                 .inputPathsMap(Map.of(
                         "inputPathsMapKey", "inputPathsMap"))
                 .build())
         .kinesisParameters(KinesisParametersProperty.builder()
                 .partitionKeyPath("partitionKeyPath")
                 .build())
         .redshiftDataParameters(RedshiftDataParametersProperty.builder()
                 .database("database")
                 .sql("sql")
                 // the properties below are optional
                 .dbUser("dbUser")
                 .secretManagerArn("secretManagerArn")
                 .statementName("statementName")
                 .withEvent(false)
                 .build())
         .retryPolicy(RetryPolicyProperty.builder()
                 .maximumEventAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .build())
         .roleArn("roleArn")
         .runCommandParameters(RunCommandParametersProperty.builder()
                 .runCommandTargets(List.of(RunCommandTargetProperty.builder()
                         .key("key")
                         .values(List.of("values"))
                         .build()))
                 .build())
         .sqsParameters(SqsParametersProperty.builder()
                 .messageGroupId("messageGroupId")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRule.TargetProperty.Builder A builder for CfnRule.TargetProperty
static class	CfnRule.TargetProperty.Jsii$Proxy An implementation for CfnRule.TargetProperty

Method Summary

Modifier and Type	Method and Description
static CfnRule.TargetProperty.Builder	builder()
String	getArn() `CfnRule.TargetProperty.Arn`.
default Object	getBatchParameters() `CfnRule.TargetProperty.BatchParameters`.
default Object	getDeadLetterConfig() `CfnRule.TargetProperty.DeadLetterConfig`.
default Object	getEcsParameters() `CfnRule.TargetProperty.EcsParameters`.
default Object	getHttpParameters() `CfnRule.TargetProperty.HttpParameters`.
String	getId() `CfnRule.TargetProperty.Id`.
default String	getInput() `CfnRule.TargetProperty.Input`.
default String	getInputPath() `CfnRule.TargetProperty.InputPath`.
default Object	getInputTransformer() `CfnRule.TargetProperty.InputTransformer`.
default Object	getKinesisParameters() `CfnRule.TargetProperty.KinesisParameters`.
default Object	getRedshiftDataParameters() `CfnRule.TargetProperty.RedshiftDataParameters`.
default Object	getRetryPolicy() `CfnRule.TargetProperty.RetryPolicy`.
default String	getRoleArn() `CfnRule.TargetProperty.RoleArn`.
default Object	getRunCommandParameters() `CfnRule.TargetProperty.RunCommandParameters`.
default Object	getSqsParameters() `CfnRule.TargetProperty.SqsParameters`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArn

@Stability(value=Stable)
 @NotNull
String getArn()

`CfnRule.TargetProperty.Arn`.

getBatchParameters

@Stability(value=Stable)
 @Nullable
default Object getBatchParameters()

`CfnRule.TargetProperty.BatchParameters`.

getDeadLetterConfig

@Stability(value=Stable)
 @Nullable
default Object getDeadLetterConfig()

`CfnRule.TargetProperty.DeadLetterConfig`.

getEcsParameters

@Stability(value=Stable)
 @Nullable
default Object getEcsParameters()

`CfnRule.TargetProperty.EcsParameters`.

getHttpParameters

@Stability(value=Stable)
 @Nullable
default Object getHttpParameters()

`CfnRule.TargetProperty.HttpParameters`.

getId

@Stability(value=Stable)
 @NotNull
String getId()

`CfnRule.TargetProperty.Id`.

getInput

@Stability(value=Stable)
 @Nullable
default String getInput()

`CfnRule.TargetProperty.Input`.

getInputPath

@Stability(value=Stable)
 @Nullable
default String getInputPath()

`CfnRule.TargetProperty.InputPath`.

getInputTransformer

@Stability(value=Stable)
 @Nullable
default Object getInputTransformer()

`CfnRule.TargetProperty.InputTransformer`.

getKinesisParameters

@Stability(value=Stable)
 @Nullable
default Object getKinesisParameters()

`CfnRule.TargetProperty.KinesisParameters`.

getRedshiftDataParameters

@Stability(value=Stable)
 @Nullable
default Object getRedshiftDataParameters()

`CfnRule.TargetProperty.RedshiftDataParameters`.

getRetryPolicy

@Stability(value=Stable)
 @Nullable
default Object getRetryPolicy()

`CfnRule.TargetProperty.RetryPolicy`.

getRoleArn

@Stability(value=Stable)
 @Nullable
default String getRoleArn()

`CfnRule.TargetProperty.RoleArn`.

getRunCommandParameters

@Stability(value=Stable)
 @Nullable
default Object getRunCommandParameters()

`CfnRule.TargetProperty.RunCommandParameters`.

getSqsParameters

@Stability(value=Stable)
 @Nullable
default Object getSqsParameters()

`CfnRule.TargetProperty.SqsParameters`.

builder

@Stability(value=Stable)
static CfnRule.TargetProperty.Builder builder()

Returns:

a CfnRule.TargetProperty.Builder of CfnRule.TargetProperty