Skip to content

Commit

Permalink
SUMO-248048: fixed the data_forwarding_destination's documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
namangoya committed Sep 24, 2024
1 parent 0789980 commit d33dd93
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions website/docs/r/data_forwarding_destination.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ Provider to manage [Sumologic Data Forwarding Destination](https://help.sumologi
```hcl
resource "sumologic_data_forwarding_destination" "example_data_forwarding_destination" {
destination_name = "df-destination"
description = ""
description = "some description"
bucket_name = "df-bucket"
region = "us-east-1"
authentication_mode = "RoleBased"
access_key_id = "accessKeyId"
secret_access_key = "secretAccessKey"
role_arn = "arn:aws:iam::some-valid-arn"
encrypted = false
s3_region = "us-east-1"
authentication {
type = "RoleBased"
role_arn = "arn:aws:iam::your_arn"
# access_key = "your access key"
# secret_key = "your secret key"
}
s3_server_side_encryption = false
enabled = true
}
```
Expand All @@ -30,12 +32,12 @@ The following arguments are supported:
- `destination_name` - (Required) Name of the S3 data forwarding destination.
- `description` - (Optional) Description of the S3 data forwarding destination.
- `bucket_name` - (Required) The name of the Amazon S3 bucket.
- `region` - (Optional) The region where the S3 bucket is located.
- `authentication_mode` - (Required) AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased`
- `access_key_id` - (Optional) The AWS Access ID to access the S3 bucket.
- `secret_access_key` - (Optional) The AWS Secret Key to access the S3 bucket.
- `s3_region` - (Optional) The region where the S3 bucket is located.
- `type` - (Required) AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased`
- `access_key` - (Optional) The AWS Access ID to access the S3 bucket.
- `secret_key` - (Optional) The AWS Secret Key to access the S3 bucket.
- `role_arn` - (Optional) The AWS Role ARN to access the S3 bucket.
- `encrypted` - (Optional) Enable S3 server-side encryption.
- `s3_server_side_encryption` - (Optional) Enable S3 server-side encryption.
- `enabled` - (Optional) True when the data forwarding destination is enabled. Will be treated as _false_ if left blank.

The following attributes are exported:
Expand Down

0 comments on commit d33dd93

Please sign in to comment.