Package software.amazon.awscdk.services.smsvoice

Class CfnConfigurationSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.smsvoice.CfnConfigurationSet
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConfigurationSetRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:14.592Z") @Stability(Stable) public class CfnConfigurationSet extends CfnResource implements IInspectable, IConfigurationSetRef, ITaggableV2
Creates a new configuration set.

After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

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.smsvoice.*;
 CfnConfigurationSet cfnConfigurationSet = CfnConfigurationSet.Builder.create(this, "MyCfnConfigurationSet")
         .configurationSetName("configurationSetName")
         .defaultSenderId("defaultSenderId")
         .eventDestinations(List.of(EventDestinationProperty.builder()
                 .enabled(false)
                 .eventDestinationName("eventDestinationName")
                 .matchingEventTypes(List.of("matchingEventTypes"))
                 // the properties below are optional
                 .cloudWatchLogsDestination(CloudWatchLogsDestinationProperty.builder()
                         .iamRoleArn("iamRoleArn")
                         .logGroupArn("logGroupArn")
                         .build())
                 .kinesisFirehoseDestination(KinesisFirehoseDestinationProperty.builder()
                         .deliveryStreamArn("deliveryStreamArn")
                         .iamRoleArn("iamRoleArn")
                         .build())
                 .snsDestination(SnsDestinationProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build()))
         .messageFeedbackEnabled(false)
         .protectConfigurationId("protectConfigurationId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationSet

      protected CfnConfigurationSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfigurationSet

      protected CfnConfigurationSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfigurationSet

      @Stability(Stable) public CfnConfigurationSet(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnConfigurationSetProps props)
      Create a new AWS::SMSVOICE::ConfigurationSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnConfigurationSet

      @Stability(Stable) public CfnConfigurationSet(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::SMSVOICE::ConfigurationSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromConfigurationSetArn

      @Stability(Stable) @NotNull public static IConfigurationSetRef fromConfigurationSetArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IConfigurationSetRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromConfigurationSetName

      @Stability(Stable) @NotNull public static IConfigurationSetRef fromConfigurationSetName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String configurationSetName)
      Creates a new IConfigurationSetRef from a configurationSetName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      configurationSetName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the ConfigurationSet.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfigurationSetRef

      @Stability(Stable) @NotNull public ConfigurationSetReference getConfigurationSetRef()
      A reference to a ConfigurationSet resource.
      Specified by:
      getConfigurationSetRef in interface IConfigurationSetRef

    • getConfigurationSetName

      @Stability(Stable) @Nullable public String getConfigurationSetName()
      The name of the ConfigurationSet.

    • setConfigurationSetName

      @Stability(Stable) public void setConfigurationSetName(@Nullable String value)
      The name of the ConfigurationSet.

    • getDefaultSenderId

      @Stability(Stable) @Nullable public String getDefaultSenderId()
      The default sender ID used by the ConfigurationSet.

    • setDefaultSenderId

      @Stability(Stable) public void setDefaultSenderId(@Nullable String value)
      The default sender ID used by the ConfigurationSet.

    • getEventDestinations

      @Stability(Stable) @Nullable public Object getEventDestinations()
      An array of EventDestination objects that describe any events to log and where to log them.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnConfigurationSet.EventDestinationProperty>

    • setEventDestinations

      @Stability(Stable) public void setEventDestinations(@Nullable IResolvable value)
      An array of EventDestination objects that describe any events to log and where to log them.

    • setEventDestinations

      @Stability(Stable) public void setEventDestinations(@Nullable List<Object> value)
      An array of EventDestination objects that describe any events to log and where to log them.

    • getMessageFeedbackEnabled

      @Stability(Stable) @Nullable public Object getMessageFeedbackEnabled()
      Set to true to enable feedback for the message.

      Returns union: either Boolean or IResolvable

    • setMessageFeedbackEnabled

      @Stability(Stable) public void setMessageFeedbackEnabled(@Nullable Boolean value)
      Set to true to enable feedback for the message.

    • setMessageFeedbackEnabled

      @Stability(Stable) public void setMessageFeedbackEnabled(@Nullable IResolvable value)
      Set to true to enable feedback for the message.

    • getProtectConfigurationId

      @Stability(Stable) @Nullable public String getProtectConfigurationId()
      The unique identifier for the protect configuration.

    • setProtectConfigurationId

      @Stability(Stable) public void setProtectConfigurationId(@Nullable String value)
      The unique identifier for the protect configuration.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key and value pair tags that's associated with the new configuration set.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key and value pair tags that's associated with the new configuration set.