Skip to content

Resource: awsChimeVoiceConnectorStreaming

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsChimeVoiceConnectorDefault =
  new aws.chimeVoiceConnector.ChimeVoiceConnector(this, "default", {
    name: "vc-name-test",
    requireEncryption: true,
  });
const awsChimeVoiceConnectorStreamingDefault =
  new aws.chimeVoiceConnectorStreaming.ChimeVoiceConnectorStreaming(
    this,
    "default_1",
    {
      dataRetention: 7,
      disabled: false,
      streamingNotificationTargets: ["SQS"],
      voiceConnectorId: awsChimeVoiceConnectorDefault.id,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsChimeVoiceConnectorStreamingDefault.overrideLogicalId("default");

Argument Reference

The following arguments are supported:

  • voiceConnectorId - (Required) The Amazon Chime Voice Connector ID.
  • dataRetention - (Required) The retention period, in hours, for the Amazon Kinesis data.
  • disabled - (Optional) When true, media streaming to Amazon Kinesis is turned off. Default: false
  • streamingNotificationTargets - (Optional) The streaming notification targets. Valid Values: eventBridge |Sns |Sqs

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The Amazon Chime Voice Connector ID.

Import

Chime Voice Connector Streaming can be imported using the voiceConnectorId, e.g.,

$ terraform import aws_chime_voice_connector_streaming.default abcdef1ghij2klmno3pqr4