Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
embeaken committed Jan 17, 2025
1 parent 530412b commit 30d267c
Show file tree
Hide file tree
Showing 4 changed files with 206 additions and 2 deletions.
2 changes: 1 addition & 1 deletion datadog/fwprovider/data_source_datadog_connection.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func (d *connectionDatasource) Schema(_ context.Context, request datasource.Sche
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"type": schema.StringAttribute{
Description: "Type of the token. Currently only STRING is allowed.",
Description: "Token type",
Computed: true,
},
"name": schema.StringAttribute{
Expand Down
2 changes: 1 addition & 1 deletion datadog/fwprovider/resource_datadog_connection.go
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ func (r *connectionResource) Schema(_ context.Context, _ resource.SchemaRequest,
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"type": schema.StringAttribute{
Description: "Type of the token",
Description: "Token type",
Optional: true,
Validators: []validator.String{
stringvalidator.OneOf("SECRET"),
Expand Down
99 changes: 99 additions & 0 deletions docs/data-sources/connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "datadog_connection Data Source - terraform-provider-datadog"
subcategory: ""
description: |-
A connection that can be used in Actions, including in the Workflow Automation and App Builder products.
---

# datadog_connection (Data Source)

A connection that can be used in Actions, including in the Workflow Automation and App Builder products.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) ID for Connection.

### Read-Only

- `aws` (Block, Read-only) Configuration for an AWS connection (see [below for nested schema](#nestedblock--aws))
- `http` (Block, Read-only) Configuration for an HTTP connection (see [below for nested schema](#nestedblock--http))
- `name` (String) Name of the connection

<a id="nestedblock--aws"></a>
### Nested Schema for `aws`

Read-Only:

- `assume_role` (Block, Read-only) Configuration for an assume role AWS connection (see [below for nested schema](#nestedblock--aws--assume_role))

<a id="nestedblock--aws--assume_role"></a>
### Nested Schema for `aws.assume_role`

Read-Only:

- `account_id` (String) AWS account the connection is created for
- `external_id` (String) External ID used to scope which connection can be used to assume the role
- `principal_id` (String) AWS account that will assume the role
- `role` (String) Role to assume



<a id="nestedblock--http"></a>
### Nested Schema for `http`

Read-Only:

- `base_url` (String) Base HTTP url for the integration
- `token_auth` (Block, Read-only) Configuration for an HTTP connection using token auth (see [below for nested schema](#nestedblock--http--token_auth))

<a id="nestedblock--http--token_auth"></a>
### Nested Schema for `http.token_auth`

Read-Only:

- `body` (Block, Read-only) Body for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--body))
- `header` (Block List) Header for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--header))
- `token` (Block List) Token for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--token))
- `url_parameter` (Block List) URL parameter for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--url_parameter))

<a id="nestedblock--http--token_auth--body"></a>
### Nested Schema for `http.token_auth.body`

Read-Only:

- `content` (String) Serialized body content
- `content_type` (String) Content type of the body


<a id="nestedblock--http--token_auth--header"></a>
### Nested Schema for `http.token_auth.header`

Read-Only:

- `name` (String) Header name
- `value` (String)


<a id="nestedblock--http--token_auth--token"></a>
### Nested Schema for `http.token_auth.token`

Read-Only:

- `name` (String) Token name
- `type` (String) Token type
- `value` (String, Sensitive) Token value


<a id="nestedblock--http--token_auth--url_parameter"></a>
### Nested Schema for `http.token_auth.url_parameter`

Read-Only:

- `name` (String) URL parameter name
- `value` (String) URL parameter value
105 changes: 105 additions & 0 deletions docs/resources/connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "datadog_connection Resource - terraform-provider-datadog"
subcategory: ""
description: |-
A connection that can be used in Actions, including in the Workflow Automation and App Builder products.
---

# datadog_connection (Resource)

A connection that can be used in Actions, including in the Workflow Automation and App Builder products.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the connection

### Optional

- `aws` (Block, Optional) Configuration for an AWS connection (see [below for nested schema](#nestedblock--aws))
- `http` (Block, Optional) Configuration for an HTTP connection (see [below for nested schema](#nestedblock--http))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--aws"></a>
### Nested Schema for `aws`

Optional:

- `assume_role` (Block, Optional) Configuration for an assume role AWS connection (see [below for nested schema](#nestedblock--aws--assume_role))

<a id="nestedblock--aws--assume_role"></a>
### Nested Schema for `aws.assume_role`

Optional:

- `account_id` (String) AWS account the connection is created for
- `role` (String) Role to assume

Read-Only:

- `external_id` (String) External ID used to scope which connection can be used to assume the role
- `principal_id` (String) AWS account that will assume the role



<a id="nestedblock--http"></a>
### Nested Schema for `http`

Optional:

- `base_url` (String) Base HTTP url for the integration
- `token_auth` (Block, Optional) Configuration for an HTTP connection using token auth (see [below for nested schema](#nestedblock--http--token_auth))

<a id="nestedblock--http--token_auth"></a>
### Nested Schema for `http.token_auth`

Optional:

- `body` (Block, Optional) Body for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--body))
- `header` (Block List) Header for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--header))
- `token` (Block List) Token for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--token))
- `url_parameter` (Block List) URL parameter for HTTP authentication (see [below for nested schema](#nestedblock--http--token_auth--url_parameter))

<a id="nestedblock--http--token_auth--body"></a>
### Nested Schema for `http.token_auth.body`

Optional:

- `content` (String) Serialized body content
- `content_type` (String) Content type of the body


<a id="nestedblock--http--token_auth--header"></a>
### Nested Schema for `http.token_auth.header`

Optional:

- `name` (String) Header name
- `value` (String)


<a id="nestedblock--http--token_auth--token"></a>
### Nested Schema for `http.token_auth.token`

Optional:

- `name` (String) Token name
- `type` (String) Token type
- `value` (String, Sensitive) Token value


<a id="nestedblock--http--token_auth--url_parameter"></a>
### Nested Schema for `http.token_auth.url_parameter`

Optional:

- `name` (String) URL parameter name
- `value` (String) URL parameter value

0 comments on commit 30d267c

Please sign in to comment.