Skip to content

Commit

Permalink
Update signalfx_aws_integration documentation (#446)
Browse files Browse the repository at this point in the history
  • Loading branch information
@akonarska
akonarska committed Jul 17, 2023
1 parent 4312d5b commit 5382b50
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 54 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ IMPROVEMENTS:
empty list to specify "all services" instead or use strings to specify selected services.
* Fix external-id field handling when token based AWS integration is created in two separate
Terraform runs.
* Update documentation for `signalfx_aws_integration`

## 7.0.0
BUGFIXES:
Expand Down
4 changes: 2 additions & 2 deletions signalfx/resource_signalfx_aws_external_integration.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ func integrationAWSExternalResource() *schema.Resource {
Type: schema.TypeString,
Computed: true,
Sensitive: true,
Description: "The SignalFx-generated AWS external ID to use with an AWS integration.",
Description: "The AWS external ID generated by Splunk Observability to use with an AWS integration.",
},
"signalfx_aws_account": &schema.Schema{
Type: schema.TypeString,
Computed: true,
Sensitive: true,
Description: "The SignalFx AWS account ID to use with an AWS role.",
Description: "The Splunk Observability AWS account ID to use with an AWS role.",
},
},

Expand Down
36 changes: 18 additions & 18 deletions signalfx/resource_signalfx_aws_integration.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,37 +54,37 @@ func integrationAWSResource() *schema.Resource {
Type: schema.TypeString,
},
Optional: true,
Description: "List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; SignalFx imports the metrics so you can monitor them.",
Description: "List of custom AWS CloudWatch namespaces to monitor. Custom namespaces contain custom metrics that you define in AWS; Splunk Observability imports the metrics so you can monitor them.",
ConflictsWith: []string{"custom_namespace_sync_rule"},
},
"custom_namespace_sync_rule": &schema.Schema{
Type: schema.TypeSet,
Optional: true,
ConflictsWith: []string{"custom_cloudwatch_namespaces"},
Description: "Each element controls the data collected by SignalFx for the specified namespace. If you specify this property, SignalFx ignores values in the \"custom_cloudwatch_namespaces\" property.",
Description: "Each element controls the data collected by Splunk Observability for the specified namespace. If you specify this property, Splunk Observability ignores values in the \"custom_cloudwatch_namespaces\" property.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"default_action": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateFilterAction,
Description: "Controls the SignalFx default behavior for processing data from an AWS namespace. The available actions are one of \"Include\" or \"Exclude\".",
Description: "Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of \"Include\" or \"Exclude\".",
},
"filter_action": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateFilterAction,
Description: "Controls how SignalFx processes data from a custom AWS namespace. The available actions are one of \"Include\" or \"Exclude\".",
Description: "Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of \"Include\" or \"Exclude\".",
},
"filter_source": {
Type: schema.TypeString,
Optional: true,
Description: "Expression that selects the data that SignalFx should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.",
Description: "Expression that selects the data that Splunk Observability should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.",
},
"namespace": {
Type: schema.TypeString,
Required: true,
Description: "An AWS custom namespace having custom AWS metrics that you want to sync with SignalFx. See the AWS documentation on publishing metrics for more information.",
Description: "An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.",
},
},
},
Expand All @@ -93,43 +93,43 @@ func integrationAWSResource() *schema.Resource {
Type: schema.TypeSet,
Optional: true,
ConflictsWith: []string{"services"},
Description: "Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that SignalFx collects for the namespace. If you specify this property, SignalFx ignores the values in the AWS CloudWatch Integration Model \"services\" property. If you don't specify either property, SignalFx syncs all data in all AWS namespaces.",
Description: "Each element in the array is an object that contains an AWS namespace name and a filter that controls the data that Splunk Observability collects for the namespace. If you specify this property, Splunk Observability ignores the values in the AWS CloudWatch Integration Model \"services\" property. If you don't specify either property, Splunk Observability syncs all data in all AWS namespaces.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"default_action": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateFilterAction,
Description: "Controls the SignalFx default behavior for processing data from an AWS namespace. SignalFx ignores this property unless you specify the \"filter\" property in the namespace sync rule. If you do specify a filter, use this property to control how SignalFx treats data that doesn't match the filter. The available actions are one of \"Include\" or \"Exclude\".",
Description: "Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the `filter_action` and `filter_source` properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of \"Include\" or \"Exclude\".",
},
"filter_action": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateFilterAction,
Description: "Controls how SignalFx processes data from a custom AWS namespace. The available actions are one of \"Include\" or \"Exclude\".",
Description: "Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of \"Include\" or \"Exclude\".",
},
"filter_source": {
Type: schema.TypeString,
Optional: true,
Description: "Expression that selects the data that SignalFx should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.",
Description: "Expression that selects the data that Splunk Observability should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.",
},
"namespace": {
Type: schema.TypeString,
Required: true,
Description: "An AWS namespace having custom AWS metrics that you want to sync with SignalFx. See the AWS documentation on publishing metrics for more information.",
Description: "An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.",
},
},
},
},
"enable_aws_usage": &schema.Schema{
Type: schema.TypeBool,
Optional: true,
Description: "Flag that controls how SignalFx imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, SignalFx imports the metrics.",
Description: "Flag that controls how Splunk Observability imports usage metrics from AWS to use with AWS Cost Optimizer. If `true`, Splunk Observability imports the metrics.",
},
"import_cloud_watch": &schema.Schema{
Type: schema.TypeBool,
Optional: true,
Description: "Flag that controls how SignalFx imports Cloud Watch metrics. If true, SignalFx imports Cloud Watch metrics from AWS.",
Description: "Flag that controls how Splunk Observability imports Cloud Watch metrics. If true, Splunk Observability imports Cloud Watch metrics from AWS.",
},
"key": {
Type: schema.TypeString,
Expand All @@ -144,7 +144,7 @@ func integrationAWSResource() *schema.Resource {
Elem: &schema.Schema{
Type: schema.TypeString,
},
Description: "List of AWS regions that SignalFx should monitor.",
Description: "List of AWS regions that Splunk Observability should monitor.",
},
"role_arn": {
Type: schema.TypeString,
Expand All @@ -158,7 +158,7 @@ func integrationAWSResource() *schema.Resource {
Elem: &schema.Schema{
Type: schema.TypeString,
},
Description: "List of AWS services that you want SignalFx to monitor. Each element is a string designating an AWS service.",
Description: "List of AWS services that you want Splunk Observability to monitor. Each element is a string designating an AWS service.",
},
"token": {
Type: schema.TypeString,
Expand Down Expand Up @@ -201,12 +201,12 @@ func integrationAWSResource() *schema.Resource {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "Controls how SignalFx checks for large amounts of data for this AWS integration. If true, SignalFx monitors the amount of data coming in from the integration.",
Description: "Controls how Splunk Observability checks for large amounts of data for this AWS integration. If true, Splunk Observability monitors the amount of data coming in from the integration.",
},
"metric_stats_to_sync": &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Description: "Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that SignalFx collects for this metric. If you specify this property, SignalFx retrieves only specified AWS statistics. If you don't specify this property, SignalFx retrieves the AWS standard set of statistics.",
Description: "Each element in the array is an object that contains an AWS namespace name, AWS metric name and a list of statistics that Splunk Observability collects for this metric. If you specify this property, Splunk Observability retrieves only specified AWS statistics. If you don't specify this property, Splunk Observability retrieves the AWS standard set of statistics.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"namespace": &schema.Schema{
Expand Down Expand Up @@ -234,7 +234,7 @@ func integrationAWSResource() *schema.Resource {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "Indicates that SignalFx should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` field for details). Defaults to `false`.",
Description: "Indicates that Splunk Observability should sync metrics and metadata from custom AWS namespaces only (see the `custom_namespace_sync_rule` field for details). Defaults to `false`.",
},
},

Expand Down
2 changes: 1 addition & 1 deletion signalfx/resource_signalfx_aws_token_integration.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func integrationAWSTokenResource() *schema.Resource {
Type: schema.TypeString,
Computed: true,
Sensitive: true,
Description: "The SignalFx AWS account ID to use with an AWS role.",
Description: "The Splunk Observability AWS account ID to use with an AWS role.",
},
},

Expand Down
12 changes: 6 additions & 6 deletions website/docs/r/aws_external_integration.html.markdown
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
layout: "signalfx"
page_title: "SignalFx: signalfx_aws_external_integration"
page_title: "Splunk Observability: signalfx_aws_external_integration"
sidebar_current: "docs-signalfx-resource-aws-external-integration"
description: |-
Allows Terraform to create and manage SignalFx AWS External ID Integrations
Allows Terraform to create and manage Splunk Observability AWS External ID Integrations
---

# Resource: signalfx_aws_external_integration

SignalFx AWS CloudWatch integrations using Role ARNs. For help with this integration see [Connect to AWS CloudWatch](https://docs.signalfx.com/en/latest/integrations/amazon-web-services.html#connect-to-aws).
Splunk Observability AWS CloudWatch integrations using Role ARNs. For help with this integration see [Connect to AWS CloudWatch](https://docs.signalfx.com/en/latest/integrations/amazon-web-services.html#connect-to-aws).

~> **NOTE** When managing integrations, use a session token of an administrator to authenticate the SignalFx provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
~> **NOTE** When managing integrations, use a session token of an administrator to authenticate the Splunk Observability provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).

~> **WARNING** This resource implements a part of a workflow. You must use it with `signalfx_aws_integration`. Check with SignalFx support for your realm's AWS account id.
~> **WARNING** This resource implements a part of a workflow. You must use it with `signalfx_aws_integration`. Check with Splunk Observability support for your realm's AWS account id.

## Example Usage

Expand Down Expand Up @@ -161,4 +161,4 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The ID of this integration, used with `signalfx_aws_integration`
* `external_id` - The external ID to use with your IAM role and with `signalfx_aws_integration`.
* `signalfx_aws_account` - The AWS Account ARN to use with your policies/roles, provided by SignalFx.
* `signalfx_aws_account` - The AWS Account ARN to use with your policies/roles, provided by Splunk Observability.
Loading

0 comments on commit 5382b50

Please sign in to comment.