Skip to content

Commit 0113979

Browse files
committed
added docs
1 parent ba6d810 commit 0113979

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
layout: "sumologic"
3+
page_title: "SumoLogic: sumologic_aws_inventory_source"
4+
description: |-
5+
Provides a Sumologic AWS Inventory source.
6+
---
7+
8+
# sumologic_aws_inventory_source
9+
Provides a Sumologic AWS Inventory source to collect AWS resource inventory data.
10+
11+
__IMPORTANT:__ The AWS credentials are stored in plain-text in the state. This is a potential security issue.
12+
13+
## Example Usage
14+
```hcl
15+
resource "sumologic_aws_inventory_source" "terraform_aws_inventory_source" {
16+
name = "AWS Inventory"
17+
description = "My description"
18+
category = "aws/terraform_aws_inventory"
19+
content_type = "AwsInventory"
20+
scan_interval = 300000
21+
paused = false
22+
collector_id = "${sumologic_collector.collector.id}"
23+
24+
authentication {
25+
type = "AWSRoleBasedAuthentication"
26+
role_arn = "arn:aws:iam::01234567890:role/sumo-role"
27+
}
28+
29+
path {
30+
type = "AwsInventoryPath"
31+
limit_to_regions = ["us-west-2"]
32+
limit_to_namespaces = ["AWS/RDS","AWS/EC2"]
33+
}
34+
}
35+
36+
resource "sumologic_collector" "collector" {
37+
name = "my-collector"
38+
description = "Just testing this"
39+
}
40+
```
41+
42+
## Argument reference
43+
44+
In addition to the common properties, the following arguments are supported:
45+
46+
- `content_type` - (Required) The content-type of the collected data. This has to be `AwsInventoryPath` for AWS Inventory source.
47+
- `scan_interval` - (Required) Time interval in milliseconds of scans for new data. The minimum value is 1000 milliseconds. Currently this value is not respected.
48+
- `paused` - (Required) When set to true, the scanner is paused. To disable, set to false.
49+
- `authentication` - (Required) Authentication details to access AWS `Describe*` APIs.
50+
+ `type` - (Required) Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`
51+
+ `access_key` - (Required) Your AWS access key if using type `S3BucketAuthentication`
52+
+ `secret_key` - (Required) Your AWS secret key if using type `S3BucketAuthentication`
53+
+ `role_arn` - (Required) Your AWS role ARN if using type `AWSRoleBasedAuthentication`
54+
- `path` - (Required) The location to scan for new data.
55+
+ `type` - (Required) type of polling source. This has to be `AwsInventoryPath` for AWS Inventory source.
56+
+ `limit_to_regions` - (Optional) List of Amazon regions.
57+
+ `limit_to_namespaces` - (Optional) List of namespaces. By default all namespaces are selected. You can also choose a subset from
58+
+ AWS/EC2
59+
+ AWS/AutoScaling
60+
+ AWS/EBS
61+
+ AWS/ELB
62+
+ AWS/ApplicationELB
63+
+ AWS/NetworkELB
64+
+ AWS/Lambda
65+
+ AWS/RDS
66+
+ AWS/Dynamodb
67+
+ AWS/ECS
68+
+ AWS/Elasticache
69+
+ AWS/Redshift
70+
+ AWS/Kinesis
71+
72+
### See also
73+
* [Common Source Properties](https://github.com/terraform-providers/terraform-provider-sumologic/tree/master/website#common-source-properties)
74+
75+
## Attributes Reference
76+
The following attributes are exported:
77+
78+
- `id` - The internal ID of the source.
79+
80+
## Import
81+
AWS Inventory sources can be imported using the collector and source IDs (`collector/source`), e.g.:
82+
83+
```hcl
84+
terraform import sumologic_aws_inventory_source.test 123/456
85+
```
86+
87+
AWS Inventory sources can be imported using the collector name and source name (`collectorName/sourceName`), e.g.:
88+
89+
```hcl
90+
terraform import sumologic_aws_inventory_source.test my-test-collector/my-test-source
91+
```

0 commit comments

Comments
 (0)