This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SMSVOICE::ProtectConfiguration
<a name="aws-resource-smsvoice-protectconfiguration"></a>

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.

## Syntax
<a name="aws-resource-smsvoice-protectconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-smsvoice-protectconfiguration-syntax.json"></a>

```
{
  "Type" : "AWS::SMSVOICE::ProtectConfiguration",
  "Properties" : {
      "[CountryRuleSet](#cfn-smsvoice-protectconfiguration-countryruleset)" : CountryRuleSet,
      "[DeletionProtectionEnabled](#cfn-smsvoice-protectconfiguration-deletionprotectionenabled)" : Boolean,
      "[Tags](#cfn-smsvoice-protectconfiguration-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-smsvoice-protectconfiguration-syntax.yaml"></a>

```
Type: AWS::SMSVOICE::ProtectConfiguration
Properties:
  [CountryRuleSet](#cfn-smsvoice-protectconfiguration-countryruleset): 
    CountryRuleSet
  [DeletionProtectionEnabled](#cfn-smsvoice-protectconfiguration-deletionprotectionenabled): Boolean
  [Tags](#cfn-smsvoice-protectconfiguration-tags): 
    - Tag
```

## Properties
<a name="aws-resource-smsvoice-protectconfiguration-properties"></a>

`CountryRuleSet`  <a name="cfn-smsvoice-protectconfiguration-countryruleset"></a>
The set of `CountryRules` you specify to control which countries AWS End User Messaging SMS can send your messages to.  
*Required*: No  
*Type*: [CountryRuleSet](aws-properties-smsvoice-protectconfiguration-countryruleset.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeletionProtectionEnabled`  <a name="cfn-smsvoice-protectconfiguration-deletionprotectionenabled"></a>
The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-smsvoice-protectconfiguration-tags"></a>
An array of key and value pair tags that are associated with the resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-smsvoice-protectconfiguration-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-smsvoice-protectconfiguration-return-values"></a>

### Ref
<a name="aws-resource-smsvoice-protectconfiguration-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns`ProtectConfigurationId`.

### Fn::GetAtt
<a name="aws-resource-smsvoice-protectconfiguration-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-smsvoice-protectconfiguration-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the protect configuration.

`ProtectConfigurationId`  <a name="ProtectConfigurationId-fn::getatt"></a>
The unique identifier for the protect configuration.

# AWS::SMSVOICE::ProtectConfiguration CountryRule
<a name="aws-properties-smsvoice-protectconfiguration-countryrule"></a>

Specifies the type of protection to use for a country.

For example, to set Canada as allowed, the `CountryRule` would be formatted as follows:

```
{
    "CountryCode": "CA",
    "ProtectStatus": "ALLOW"                          
}
```

## Syntax
<a name="aws-properties-smsvoice-protectconfiguration-countryrule-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-smsvoice-protectconfiguration-countryrule-syntax.json"></a>

```
{
  "[CountryCode](#cfn-smsvoice-protectconfiguration-countryrule-countrycode)" : String,
  "[ProtectStatus](#cfn-smsvoice-protectconfiguration-countryrule-protectstatus)" : String
}
```

### YAML
<a name="aws-properties-smsvoice-protectconfiguration-countryrule-syntax.yaml"></a>

```
  [CountryCode](#cfn-smsvoice-protectconfiguration-countryrule-countrycode): String
  [ProtectStatus](#cfn-smsvoice-protectconfiguration-countryrule-protectstatus): String
```

## Properties
<a name="aws-properties-smsvoice-protectconfiguration-countryrule-properties"></a>

`CountryCode`  <a name="cfn-smsvoice-protectconfiguration-countryrule-countrycode"></a>
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Z]{2}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProtectStatus`  <a name="cfn-smsvoice-protectconfiguration-countryrule-protectstatus"></a>
The types of protection that can be used.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ALLOW | BLOCK | MONITOR | FILTER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SMSVOICE::ProtectConfiguration CountryRuleSet
<a name="aws-properties-smsvoice-protectconfiguration-countryruleset"></a>

The set of `CountryRules` you specify to control which countries AWS End User Messaging SMS can send your messages to.

**Note**  
If you don't specify all available ISO country codes in the `CountryRuleSet` for each number capability, the CloudFormation drift detection feature will detect drift. This is because AWS End User Messaging SMS always returns all country codes.

## Syntax
<a name="aws-properties-smsvoice-protectconfiguration-countryruleset-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-smsvoice-protectconfiguration-countryruleset-syntax.json"></a>

```
{
  "[MMS](#cfn-smsvoice-protectconfiguration-countryruleset-mms)" : [ CountryRule, ... ],
  "[SMS](#cfn-smsvoice-protectconfiguration-countryruleset-sms)" : [ CountryRule, ... ],
  "[VOICE](#cfn-smsvoice-protectconfiguration-countryruleset-voice)" : [ CountryRule, ... ]
}
```

### YAML
<a name="aws-properties-smsvoice-protectconfiguration-countryruleset-syntax.yaml"></a>

```
  [MMS](#cfn-smsvoice-protectconfiguration-countryruleset-mms): 
    - CountryRule
  [SMS](#cfn-smsvoice-protectconfiguration-countryruleset-sms): 
    - CountryRule
  [VOICE](#cfn-smsvoice-protectconfiguration-countryruleset-voice): 
    - CountryRule
```

## Properties
<a name="aws-properties-smsvoice-protectconfiguration-countryruleset-properties"></a>

`MMS`  <a name="cfn-smsvoice-protectconfiguration-countryruleset-mms"></a>
The set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your MMS messages to.  
*Required*: No  
*Type*: Array of [CountryRule](aws-properties-smsvoice-protectconfiguration-countryrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SMS`  <a name="cfn-smsvoice-protectconfiguration-countryruleset-sms"></a>
The set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your SMS messages to.  
*Required*: No  
*Type*: Array of [CountryRule](aws-properties-smsvoice-protectconfiguration-countryrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VOICE`  <a name="cfn-smsvoice-protectconfiguration-countryruleset-voice"></a>
The set of `CountryRule`s to control which destination countries AWS End User Messaging SMS can send your VOICE messages to.  
*Required*: No  
*Type*: Array of [CountryRule](aws-properties-smsvoice-protectconfiguration-countryrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SMSVOICE::ProtectConfiguration Tag
<a name="aws-properties-smsvoice-protectconfiguration-tag"></a>

The list of tags to be added to the specified topic.

## Syntax
<a name="aws-properties-smsvoice-protectconfiguration-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-smsvoice-protectconfiguration-tag-syntax.json"></a>

```
{
  "[Key](#cfn-smsvoice-protectconfiguration-tag-key)" : String,
  "[Value](#cfn-smsvoice-protectconfiguration-tag-value)" : String
}
```

### YAML
<a name="aws-properties-smsvoice-protectconfiguration-tag-syntax.yaml"></a>

```
  [Key](#cfn-smsvoice-protectconfiguration-tag-key): String
  [Value](#cfn-smsvoice-protectconfiguration-tag-value): String
```

## Properties
<a name="aws-properties-smsvoice-protectconfiguration-tag-properties"></a>

`Key`  <a name="cfn-smsvoice-protectconfiguration-tag-key"></a>
The key identifier, or name, of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-smsvoice-protectconfiguration-tag-value"></a>
The string value associated with the key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)