Package software.amazon.awscdk.services.smsvoice

Class CfnProtectConfiguration

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.CfnProtectConfiguration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IProtectConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:15.465Z") @Stability(Stable) public class CfnProtectConfiguration extends CfnResource implements IInspectable, IProtectConfigurationRef, ITaggableV2
Create a new protect configuration.

By default all country rule sets for each capability are set to ALLOW . A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

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.*;
 CfnProtectConfiguration cfnProtectConfiguration = CfnProtectConfiguration.Builder.create(this, "MyCfnProtectConfiguration")
         .countryRuleSet(CountryRuleSetProperty.builder()
                 .mms(List.of(CountryRuleProperty.builder()
                         .countryCode("countryCode")
                         .protectStatus("protectStatus")
                         .build()))
                 .sms(List.of(CountryRuleProperty.builder()
                         .countryCode("countryCode")
                         .protectStatus("protectStatus")
                         .build()))
                 .voice(List.of(CountryRuleProperty.builder()
                         .countryCode("countryCode")
                         .protectStatus("protectStatus")
                         .build()))
                 .build())
         .deletionProtectionEnabled(false)
         .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

    • CfnProtectConfiguration

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

    • CfnProtectConfiguration

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

    • CfnProtectConfiguration

      @Stability(Stable) public CfnProtectConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnProtectConfigurationProps props)
      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.

    • CfnProtectConfiguration

      @Stability(Stable) public CfnProtectConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id)
      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

    • fromProtectConfigurationArn

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

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

    • fromProtectConfigurationId

      @Stability(Stable) @NotNull public static IProtectConfigurationRef fromProtectConfigurationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String protectConfigurationId)
      Creates a new IProtectConfigurationRef from a protectConfigurationId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      protectConfigurationId - 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 protect configuration.

    • getAttrProtectConfigurationId

      @Stability(Stable) @NotNull public String getAttrProtectConfigurationId()
      The unique identifier for the protect configuration.

    • 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

    • getProtectConfigurationRef

      @Stability(Stable) @NotNull public ProtectConfigurationReference getProtectConfigurationRef()
      A reference to a ProtectConfiguration resource.
      Specified by:
      getProtectConfigurationRef in interface IProtectConfigurationRef

    • getCountryRuleSet

      @Stability(Stable) @Nullable public Object getCountryRuleSet()
      The set of CountryRules you specify to control which countries End User Messaging can send your messages to.

      Returns union: either IResolvable or CfnProtectConfiguration.CountryRuleSetProperty

    • setCountryRuleSet

      @Stability(Stable) public void setCountryRuleSet(@Nullable IResolvable value)
      The set of CountryRules you specify to control which countries End User Messaging can send your messages to.

    • setCountryRuleSet

      @Stability(Stable) public void setCountryRuleSet(@Nullable CfnProtectConfiguration.CountryRuleSetProperty value)
      The set of CountryRules you specify to control which countries End User Messaging can send your messages to.

    • getDeletionProtectionEnabled

      @Stability(Stable) @Nullable public Object getDeletionProtectionEnabled()
      The status of deletion protection for the protect configuration.

      Returns union: either Boolean or IResolvable

    • setDeletionProtectionEnabled

      @Stability(Stable) public void setDeletionProtectionEnabled(@Nullable Boolean value)
      The status of deletion protection for the protect configuration.

    • setDeletionProtectionEnabled

      @Stability(Stable) public void setDeletionProtectionEnabled(@Nullable IResolvable value)
      The status of deletion protection for the protect configuration.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key and value pair tags that are associated with the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key and value pair tags that are associated with the resource.