Skip to content

Commit 87162b3

Browse files
committed
aws_codeguruprofiler_profiling_group: add resource documentation
1 parent a7d6b53 commit 87162b3

File tree

3 files changed

+21
-19
lines changed

3 files changed

+21
-19
lines changed

internal/service/codeguruprofiler/profiling_group_data_source_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func TestAccCodeGuruProfilerProfilingGroupDataSource_basic(t *testing.T) {
5151
func testAccProfilingGroupDataSourceConfig_basic(rName string) string {
5252
return fmt.Sprintf(`
5353
resource "aws_codeguruprofiler_profiling_group" "test" {
54-
name = %[1]q
54+
name = %[1]q
5555
compute_platform = "Default"
5656
5757
agent_orchestration_config {
@@ -60,7 +60,7 @@ resource "aws_codeguruprofiler_profiling_group" "test" {
6060
}
6161
6262
data "aws_codeguruprofiler_profiling_group" "test" {
63-
name = aws_codeguruprofiler_profiling_group.test.name
63+
name = aws_codeguruprofiler_profiling_group.test.name
6464
}
6565
`, rName)
6666
}

internal/service/codeguruprofiler/profiling_group_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ func testAccPreCheck(ctx context.Context, t *testing.T) {
250250
func testAccProfilingGroupConfig_basic(rName string) string {
251251
return fmt.Sprintf(`
252252
resource "aws_codeguruprofiler_profiling_group" "test" {
253-
name = %[1]q
253+
name = %[1]q
254254
compute_platform = "Default"
255255
256256
agent_orchestration_config {
@@ -263,7 +263,7 @@ resource "aws_codeguruprofiler_profiling_group" "test" {
263263
func testAccProfilingGroupConfig_update(rName string, profilingEnabled bool) string {
264264
return fmt.Sprintf(`
265265
resource "aws_codeguruprofiler_profiling_group" "test" {
266-
name = %[1]q
266+
name = %[1]q
267267
compute_platform = "Default"
268268
269269
agent_orchestration_config {
@@ -276,7 +276,7 @@ resource "aws_codeguruprofiler_profiling_group" "test" {
276276
func testAccProfilingGroupConfig_tags1(rName, key1, value1 string) string {
277277
return fmt.Sprintf(`
278278
resource "aws_codeguruprofiler_profiling_group" "test" {
279-
name = %[1]q
279+
name = %[1]q
280280
compute_platform = "Default"
281281
282282
agent_orchestration_config {
@@ -292,7 +292,7 @@ resource "aws_codeguruprofiler_profiling_group" "test" {
292292
func testAccProfilingGroupConfig_tags2(rName, key1, value1, key2, value2 string) string {
293293
return fmt.Sprintf(`
294294
resource "aws_codeguruprofiler_profiling_group" "test" {
295-
name = %[1]q
295+
name = %[1]q
296296
compute_platform = "Default"
297297
298298
agent_orchestration_config {

website/docs/r/codeguruprofiler_profiling_group.html.markdown

+15-13
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,37 @@ Terraform resource for managing an AWS CodeGuru Profiler Profiling Group.
1515

1616
```terraform
1717
resource "aws_codeguruprofiler_profiling_group" "example" {
18+
name = "example"
19+
compute_platform = "Default"
20+
21+
agent_orchestration_config {
22+
profiling_enabled = true
23+
}
1824
}
1925
```
2026

2127
## Argument Reference
2228

2329
The following arguments are required:
2430

25-
* `example_arg` - (Required) Concise argument description. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
31+
* `agent_orchestration_config` - (Required) Specifies whether profiling is enabled or disabled for the created profiling. See [Agent Orchestration Config](#agent-orchestration-config) for more details.
32+
* `name` - (Required) The name of the profiling group to create.
2633

2734
The following arguments are optional:
2835

29-
* `optional_arg` - (Optional) Concise argument description. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
36+
* `compute_platform` - (Optional) The compute platform of the profiling group.
3037
* `tags` - (Optional) A map of tags assigned to the WorkSpaces Connection Alias. 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.
3138

3239
## Attribute Reference
3340

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

36-
* `arn` - ARN of the Profiling Group. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
37-
* `example_attribute` - Concise description. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
43+
* `arn` - ARN of the Profiling Group.
3844
* `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).
3945

40-
## Timeouts
41-
42-
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
46+
### Agent Orchestration Config
4347

44-
* `create` - (Default `60m`)
45-
* `update` - (Default `180m`)
46-
* `delete` - (Default `90m`)
48+
* `profiling_enabled` - (Required) Boolean that specifies whether the profiling agent collects profiling data or
4749

4850
## Import
4951

@@ -52,12 +54,12 @@ In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashico
5254
```terraform
5355
import {
5456
to = aws_codeguruprofiler_profiling_group.example
55-
id = "profiling_group-id-12345678"
57+
id = "profiling_group-name-12345678"
5658
}
5759
```
5860

59-
Using `terraform import`, import CodeGuru Profiler Profiling Group using the `example_id_arg`. For example:
61+
Using `terraform import`, import CodeGuru Profiler Profiling Group using the `name`. For example:
6062

6163
```console
62-
% terraform import aws_codeguruprofiler_profiling_group.example profiling_group-id-12345678
64+
% terraform import aws_codeguruprofiler_profiling_group.example profiling_group-name-12345678
6365
```

0 commit comments

Comments
 (0)