Skip to content

Commit

Permalink
docs and gen
Browse files Browse the repository at this point in the history
  • Loading branch information
jchorl committed Jun 16, 2023
1 parent eb5eb29 commit f9a49ae
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 1 deletion.
3 changes: 3 additions & 0 deletions internal/service/sesv2/service_package_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 42 additions & 0 deletions website/docs/d/sesv2_email_identity.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
subcategory: "SESv2 (Simple Email V2)"
layout: "aws"
page_title: "AWS: aws_sesv2_email_identity"
description: |-
Terraform data source for managing an AWS SESv2 (Simple Email V2) Email Identity.
---

# Data Source: aws_sesv2_email_identity

Terraform data source for managing an AWS SESv2 (Simple Email V2) Email Identity.

## Example Usage

### Basic Usage

```terraform
data "aws_sesv2_email_identity" "example" {
email_identity = "example.com"
}
```

## Argument Reference

The following arguments are required:

* `email_identity` - (Required) The name of the email identity.

## Attributes Reference

In addition to all arguments above, the following attributes are exported:

* `arn` - ARN of the Email Identity.
* `dkim_signing_attributes` - A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
* `current_signing_key_length` - [Easy DKIM] The key length of the DKIM key pair in use.
* `last_key_generation_timestamp` - [Easy DKIM] The last time a key pair was generated for this identity.
* `next_signing_key_length` - [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
* `signing_attributes_origin` - A string that indicates how DKIM was configured for the identity. `AWS_SES` indicates that DKIM was configured for the identity by using Easy DKIM. `EXTERNAL` indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
* `status` - Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the [AWS SES API v2 Reference](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_DkimAttributes.html#SES-Type-DkimAttributes-Status) for supported statuses.
* `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
* `identity_type` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`.
* `verified_for_sending_status` - Specifies whether or not the identity is verified.
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
subcategory: "SESv2 (Simple Email V2)"
layout: "aws"
page_title: "AWS: aws_sesv2_email_identity_mail_from_attributes"
description: |-
Terraform data source for managing an AWS SESv2 (Simple Email V2) Email Identity Mail From Attributes.
---

# Data Source: aws_sesv2_email_identity_mail_from_attributes

Terraform data source for managing an AWS SESv2 (Simple Email V2) Email Identity Mail From Attributes.

## Example Usage

### Basic Usage

```terraform
data "aws_sesv2_email_identity" "example" {
email_identity = "example.com"
}
data "aws_sesv2_email_identity_mail_from_attributes" "example" {
email_identity = data.aws_sesv2_email_identity.example.email_identity
}
```

## Argument Reference

The following arguments are required:

* `email_identity` - (Required) The name of the email identity.

## Attributes Reference

In addition to all arguments above, the following attributes are exported:

* `behavior_on_mx_failure` - The action to take if the required MX record isn't found when you send an email. Valid values: `USE_DEFAULT_VALUE`, `REJECT_MESSAGE`.
* `mail_from_domain` - The custom MAIL FROM domain that you want the verified identity to use.
2 changes: 1 addition & 1 deletion website/docs/r/sesv2_email_identity.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The following arguments are supported:
In addition to all arguments above, the following attributes are exported:

* `arn` - ARN of the Email Identity.
* `dkim_signing_attributes` - An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
* `dkim_signing_attributes` - A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
* `current_signing_key_length` - [Easy DKIM] The key length of the DKIM key pair in use.
* `last_key_generation_timestamp` - [Easy DKIM] The last time a key pair was generated for this identity.
* `next_signing_key_length` - [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
Expand Down

0 comments on commit f9a49ae

Please sign in to comment.