@pulumi/aws/sesv2/getEmailIdentity.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Data source for managing an AWS SESv2 (Simple Email V2) Email Identity.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.sesv2.getEmailIdentity({
 *     emailIdentity: "example.com",
 * });
 * ```
 */
export declare function getEmailIdentity(args: GetEmailIdentityArgs, opts?: pulumi.InvokeOptions): Promise<GetEmailIdentityResult>;
/**
 * A collection of arguments for invoking getEmailIdentity.
 */
export interface GetEmailIdentityArgs {
    /**
     * The name of the email identity.
     */
    emailIdentity: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Key-value mapping of resource tags.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getEmailIdentity.
 */
export interface GetEmailIdentityResult {
    /**
     * ARN of the Email Identity.
     */
    readonly arn: string;
    readonly configurationSetName: string;
    /**
     * 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.
     */
    readonly dkimSigningAttributes: outputs.sesv2.GetEmailIdentityDkimSigningAttribute[];
    readonly emailIdentity: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`.
     */
    readonly identityType: string;
    readonly region: string;
    /**
     * Key-value mapping of resource tags.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`.
     */
    readonly verificationStatus: string;
    /**
     * Specifies whether or not the identity is verified.
     */
    readonly verifiedForSendingStatus: boolean;
}
/**
 * Data source for managing an AWS SESv2 (Simple Email V2) Email Identity.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.sesv2.getEmailIdentity({
 *     emailIdentity: "example.com",
 * });
 * ```
 */
export declare function getEmailIdentityOutput(args: GetEmailIdentityOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEmailIdentityResult>;
/**
 * A collection of arguments for invoking getEmailIdentity.
 */
export interface GetEmailIdentityOutputArgs {
    /**
     * The name of the email identity.
     */
    emailIdentity: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Key-value mapping of resource tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}