View a markdown version of this page

AWS::SMSVOICE::RcsAgent - AWS CloudFormation
SyntaxPropertiesReturn values

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.

AWS::SMSVOICE::RcsAgent

Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::RcsAgent",
  "Properties" : {
      "DeletionProtectionEnabled" : Boolean,
      "OptOutListName" : String,
      "SelfManagedOptOutsEnabled" : Boolean,
      "Tags" : [ Tag, ... ],
      "TwoWayChannelArn" : String,
      "TwoWayChannelRole" : String,
      "TwoWayEnabled" : Boolean,
      "TwoWayMediaS3BucketName" : String,
      "TwoWayMediaS3KeyPrefix" : String,
      "TwoWayMediaS3Role" : String,
      "TwoWayRcsEventsEnabled" : [ String, ... ]
    }
}

YAML

Type: AWS::SMSVOICE::RcsAgent
Properties:
  DeletionProtectionEnabled: Boolean
  OptOutListName: String
  SelfManagedOptOutsEnabled: Boolean
  Tags: 
    - Tag
  TwoWayChannelArn: String
  TwoWayChannelRole: String
  TwoWayEnabled: Boolean
  TwoWayMediaS3BucketName: String
  TwoWayMediaS3KeyPrefix: String
  TwoWayMediaS3Role: String
  TwoWayRcsEventsEnabled: 
    - String

Properties

DeletionProtectionEnabled

When set to true the RCS agent can't be deleted.

Required: No

Type: Boolean

Update requires: No interruption

OptOutListName

The name of the OptOutList associated with the RCS agent.

Required: No

Type: String

Pattern: ^[A-Za-z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

SelfManagedOptOutsEnabled

When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Required: No

Type: Boolean

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

TwoWayChannelArn

The Amazon Resource Name (ARN) of the two way channel.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 20

Maximum: 2048

Update requires: No interruption

TwoWayChannelRole

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Required: No

Type: String

Pattern: ^arn:\S+$

Minimum: 20

Maximum: 2048

Update requires: No interruption

TwoWayEnabled

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

Required: No

Type: Boolean

Update requires: No interruption

TwoWayMediaS3BucketName

The name of the S3 bucket where inbound RCS media files are stored.

Required: No

Type: String

Pattern: ^[a-z0-9][a-z0-9.-]*[a-z0-9]$

Minimum: 3

Maximum: 63

Update requires: No interruption

TwoWayMediaS3KeyPrefix

The key prefix used for inbound RCS media objects in the S3 bucket.

Required: No

Type: String

Pattern: ^[\S]+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

TwoWayMediaS3Role

The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.

Required: No

Type: String

Pattern: ^arn:\S+$

Minimum: 20

Maximum: 2048

Update requires: No interruption

TwoWayRcsEventsEnabled

The list of RCS event types enabled for two-way messaging on the agent.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 50 | 100

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedTimestamp

The time when the RCS agent was created, in UNIX epoch time format.

PoolId

The unique identifier of the pool associated with the RCS agent.

RcsAgentArn

The Amazon Resource Name (ARN) of the RCS agent.

RcsAgentId

The unique identifier for the RCS agent.

Status

The current status of the RCS agent.