Skip to content

Commit da6fd10

Browse files
author
Naman Goyal
committed
SUMO-178423: added html documentation and minor refactoring
1 parent 3fe60a0 commit da6fd10

File tree

4 files changed

+45
-4
lines changed

4 files changed

+45
-4
lines changed

sumologic/provider.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ func Provider() terraform.ResourceProvider {
9292
"sumologic_folder": resourceSumologicFolder(),
9393
"sumologic_content": resourceSumologicContent(),
9494
"sumologic_scheduled_view": resourceSumologicScheduledView(),
95-
"sumologic_s3_data_forwarding_destination": resourceSumologicDataForwardingDestination(),
95+
"sumologic_data_forwarding_destination": resourceSumologicDataForwardingDestination(),
9696
"sumologic_partition": resourceSumologicPartition(),
9797
"sumologic_field_extraction_rule": resourceSumologicFieldExtractionRule(),
9898
"sumologic_connection": resourceSumologicConnection(),

sumologic/resource_sumologic_data_forwarding_test.go renamed to sumologic/resource_sumologic_data_forwarding_destination_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
)
1212

1313
func getTestParams() (string, string, string, string, string, string) {
14-
dataForwardingResourceName := "sumologic_s3_data_forwarding_destination.test"
14+
dataForwardingResourceName := "sumologic_data_forwarding_destination.test"
1515
destinationName, description := getRandomizedDataForwardingParams()
1616
testAwsRoleArn := os.Getenv("SUMOLOGIC_TEST_ROLE_ARN")
1717
testAwsBucket := os.Getenv("SUMOLOGIC_TEST_BUCKET_NAME")
@@ -168,7 +168,7 @@ func testAccCheckDataForwardingDestroy() resource.TestCheckFunc {
168168

169169
func testAccSumologicDataForwardingCreateConfig(destinationName string, description string, testAwsBucket string, testAwsRoleArn string, testAwsRegion string) string {
170170
return fmt.Sprintf(`
171-
resource "sumologic_s3_data_forwarding_destination" "test" {
171+
resource "sumologic_data_forwarding_destination" "test" {
172172
destination_name = "%s"
173173
description = "%s"
174174
bucket_name = "%s"
@@ -184,7 +184,7 @@ resource "sumologic_s3_data_forwarding_destination" "test" {
184184

185185
func testAccSumologicDataForwardingUpdateConfig(destinationName string, description string, testAwsBucket string, testAwsRoleArn string, testAwsRegion string) string {
186186
return fmt.Sprintf(`
187-
resource "sumologic_s3_data_forwarding_destination" "test" {
187+
resource "sumologic_data_forwarding_destination" "test" {
188188
destination_name = "%s"
189189
description = "%s"
190190
bucket_name = "%s"
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: "sumologic"
3+
page_title: "SumoLogic: sumologic_data_forwarding_destination"
4+
description: |-
5+
Provides a Sumologic Data Forwarding Destination
6+
---
7+
8+
# sumologic_data_forwarding_destination
9+
Provider to manage [Sumologic Data Forwarding Destination](https://help.sumologic.com/docs/manage/data-forwarding/amazon-s3-bucket/#configure-an-s3-data-forwarding-destination)
10+
11+
## Example Usage
12+
```hcl
13+
resource "sumologic_data_forwarding_destination" "example_data_forwarding_destination" {
14+
destination_name = "df-destination"
15+
description = ""
16+
bucket_name = "df-bucket"
17+
region = "us-east-1"
18+
authentication_mode = "RoleBased"
19+
access_key_id = "accessKeyId"
20+
secret_access_key = "secretAccessKey"
21+
role_arn = "arn:aws:iam::some-valid-arn"
22+
encrypted = "false"
23+
}
24+
```
25+
## Argument reference
26+
27+
The following arguments are supported:
28+
29+
- `destination_name` - (Required) Name of the S3 data forwarding destination.
30+
- `description` - (Optional) Description of the S3 data forwarding destination.
31+
- `bucket_name` - (Required) The name of the Amazon S3 bucket.
32+
- `region` - (Optional) The region where the S3 bucket is located.
33+
- `authentication_mode` - (Required) AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased`
34+
- `access_key_id` - (Optional) The AWS Access ID to access the S3 bucket.
35+
- `secret_access_key` - (Optional) The AWS Secret Key to access the S3 bucket.
36+
- `role_arn` - (Optional) The AWS Role ARN to access the S3 bucket.
37+
- `encrypted` - (Optional) Enable S3 server-side encryption.
38+
39+
The following attributes are exported:
40+
41+
- `id` - The internal ID of the data_forwarding_destination

0 commit comments

Comments
 (0)