CfnRcsAgentProps Struct
Properties for defining a CfnRcsAgent.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_smsvoice as smsvoice } from 'aws-cdk-lib';
const cfnRcsAgentProps: smsvoice.CfnRcsAgentProps = {
deletionProtectionEnabled: false,
optOutListName: 'optOutListName',
selfManagedOptOutsEnabled: false,
tags: [{
key: 'key',
value: 'value',
}],
twoWayChannelArn: 'twoWayChannelArn',
twoWayChannelRole: 'twoWayChannelRole',
twoWayEnabled: false,
twoWayMediaS3BucketName: 'twoWayMediaS3BucketName',
twoWayMediaS3KeyPrefix: 'twoWayMediaS3KeyPrefix',
twoWayMediaS3Role: 'twoWayMediaS3Role',
twoWayRcsEventsEnabled: ['twoWayRcsEventsEnabled'],
};
Properties
deletionProtectionEnabledoptionalboolean | IResolvabledeletion_protection_enabledoptionaltyping.Union[bool, IResolvable]deletionProtectionEnabledoptionalBooleanDeletionProtectionEnabledoptionalboolDeletionProtectionEnabledoptionalinterface{}#When set to true the RCS agent can't be deleted.
By default this is false.
optOutListNameoptionalstringopt_out_list_nameoptionalstroptOutListNameoptionalStringOptOutListNameoptionalstringOptOutListNameoptional*string#The name of the opt-out list associated with the RCS agent.
selfManagedOptOutsEnabledoptionalboolean | IResolvableself_managed_opt_outs_enabledoptionaltyping.Union[bool, IResolvable]selfManagedOptOutsEnabledoptionalBooleanSelfManagedOptOutsEnabledoptionalboolSelfManagedOptOutsEnabledoptionalinterface{}#When set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests.
By default this is false.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs to apply to the RCS agent.
twoWayChannelArnoptionalstringtwo_way_channel_arnoptionalstrtwoWayChannelArnoptionalStringTwoWayChannelArnoptionalstringTwoWayChannelArnoptional*string#The Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
twoWayChannelRoleoptionalstringtwo_way_channel_roleoptionalstrtwoWayChannelRoleoptionalStringTwoWayChannelRoleoptionalstringTwoWayChannelRoleoptional*string#The Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
twoWayEnabledoptionalboolean | IResolvabletwo_way_enabledoptionaltyping.Union[bool, IResolvable]twoWayEnabledoptionalBooleanTwoWayEnabledoptionalboolTwoWayEnabledoptionalinterface{}#When set to true two-way messaging is enabled for the RCS agent.
twoWayMediaS3BucketNameoptionalstringtwo_way_media_s3_bucket_nameoptionalstrtwoWayMediaS3BucketNameoptionalStringTwoWayMediaS3BucketNameoptionalstringTwoWayMediaS3BucketNameoptional*string#The name of the Amazon S3 bucket where inbound RCS media objects are written.
twoWayMediaS3KeyPrefixoptionalstringtwo_way_media_s3_key_prefixoptionalstrtwoWayMediaS3KeyPrefixoptionalStringTwoWayMediaS3KeyPrefixoptionalstringTwoWayMediaS3KeyPrefixoptional*string#The key prefix used for inbound RCS media objects in the Amazon S3 bucket.
twoWayMediaS3Roleoptionalstringtwo_way_media_s3_roleoptionalstrtwoWayMediaS3RoleoptionalStringTwoWayMediaS3RoleoptionalstringTwoWayMediaS3Roleoptional*string#The Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket.
The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
twoWayRcsEventsEnabledoptionalstring[]two_way_rcs_events_enabledoptionaltyping.List[str]twoWayRcsEventsEnabledoptionalList<String>TwoWayRcsEventsEnabledoptionalstring[]TwoWayRcsEventsEnabledoptional*[]*string#The list of RCS event types enabled for two-way messaging.
An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.