Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceharrison1984 committed Sep 19, 2024
1 parent 499c15b commit 4892c1f
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions website/docs/r/connect_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-
Provides an Amazon Connect instance resource. For more information see
[Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html)

!> **WARN:** Amazon Connect enforces a limit of [100 combined instance creation and deletions every 30 days](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits). For example, if you create 80 instances and delete 20 of them, you must wait 30 days to create or delete another instance. Use care when creating or deleting instances.
!> **WARN:** Amazon Connect enforces a limit of [100 combined instance creation and deletions every 30 days](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits). For example, if you create 80 instances and delete 20 of them, you must wait 30 days to create or delete another instance. Use care when creating or deleting instances.

## Example Usage

Expand All @@ -21,6 +21,10 @@ resource "aws_connect_instance" "test" {
inbound_calls_enabled = true
instance_alias = "friendly-name-connect"
outbound_calls_enabled = true
tags = {
"hello" = "world"
}
}
```

Expand Down Expand Up @@ -51,34 +55,36 @@ resource "aws_connect_instance" "test" {

This resource supports the following arguments:

* `auto_resolve_best_voices_enabled` - (Optional) Specifies whether auto resolve best voices is enabled. Defaults to `true`.
* `contact_flow_logs_enabled` - (Optional) Specifies whether contact flow logs are enabled. Defaults to `false`.
* `contact_lens_enabled` - (Optional) Specifies whether contact lens is enabled. Defaults to `true`.
* `directory_id` - (Optional) The identifier for the directory if identity_management_type is `EXISTING_DIRECTORY`.
* `early_media_enabled` - (Optional) Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
* `identity_management_type` - (Required) Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
* `inbound_calls_enabled` - (Required) Specifies whether inbound calls are enabled.
* `instance_alias` - (Optional) Specifies the name of the instance. Required if `directory_id` not specified.
* `multi_party_conference_enabled` - (Optional) Specifies whether multi-party calls/conference is enabled. Defaults to `false`.
* `outbound_calls_enabled` - (Required) Specifies whether outbound calls are enabled.
- `auto_resolve_best_voices_enabled` - (Optional) Specifies whether auto resolve best voices is enabled. Defaults to `true`.
- `contact_flow_logs_enabled` - (Optional) Specifies whether contact flow logs are enabled. Defaults to `false`.
- `contact_lens_enabled` - (Optional) Specifies whether contact lens is enabled. Defaults to `true`.
- `directory_id` - (Optional) The identifier for the directory if identity_management_type is `EXISTING_DIRECTORY`.
- `early_media_enabled` - (Optional) Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
- `identity_management_type` - (Required) Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
- `inbound_calls_enabled` - (Required) Specifies whether inbound calls are enabled.
- `instance_alias` - (Optional) Specifies the name of the instance. Required if `directory_id` not specified.
- `multi_party_conference_enabled` - (Optional) Specifies whether multi-party calls/conference is enabled. Defaults to `false`.
- `outbound_calls_enabled` - (Required) Specifies whether outbound calls are enabled.
- `tags` - (Optional) Tags to apply to the Instance. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
<!-- * `use_custom_tts_voices` - (Optional) Whether use custom tts voices is enabled. Defaults to `false` -->

## Attribute Reference

This resource exports the following attributes in addition to the arguments above:

* `id` - The identifier of the instance.
* `arn` - Amazon Resource Name (ARN) of the instance.
* `created_time` - When the instance was created.
* `service_role` - The service role of the instance.
* `status` - The state of the instance.
- `id` - The identifier of the instance.
- `arn` - Amazon Resource Name (ARN) of the instance.
- `created_time` - When the instance was created.
- `service_role` - The service role of the instance.
- `status` - The state of the instance.
- `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block).

## Timeouts

[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):

* `create` - (Default `5m`)
* `delete` - (Default `5m`)
- `create` - (Default `5m`)
- `delete` - (Default `5m`)

## Import

Expand Down

0 comments on commit 4892c1f

Please sign in to comment.