UNPKG

@pulumi/aws

Version:

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

148 lines (147 loc) 4.92 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages an AWS SESv2 (Simple Email V2) Tenant. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.sesv2.Tenant("example", { * tenantName: "example-tenant", * tags: { * Environment: "test", * }, * }); * ``` * * ## Import * * Using `pulumi import`, import an SESv2 Tenant using the `tenant_name`. For example: * * ```sh * $ pulumi import aws:sesv2/tenant:Tenant example example-tenant * ``` */ export declare class Tenant extends pulumi.CustomResource { /** * Get an existing Tenant resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TenantState, opts?: pulumi.CustomResourceOptions): Tenant; /** * Returns true if the given object is an instance of Tenant. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Tenant; /** * 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. */ readonly region: pulumi.Output<string>; /** * Current sending status of the tenant. */ readonly sendingStatus: pulumi.Output<string>; /** * Map of tags to assign to the tenant. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the tenant, including provider default tags. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * ARN of the Tenant. */ readonly tenantArn: pulumi.Output<string>; /** * ID of the Tenant. */ readonly tenantId: pulumi.Output<string>; /** * Name of the SESV2 tenant. The name must be unique within the AWS account and Region. Changing the tenant name forces creation of a new tenant. * * The following arguments are optional: */ readonly tenantName: pulumi.Output<string>; /** * Create a Tenant resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: TenantArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Tenant resources. */ export interface TenantState { /** * 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>; /** * Current sending status of the tenant. */ sendingStatus?: pulumi.Input<string>; /** * Map of tags to assign to the tenant. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Map of tags assigned to the tenant, including provider default tags. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * ARN of the Tenant. */ tenantArn?: pulumi.Input<string>; /** * ID of the Tenant. */ tenantId?: pulumi.Input<string>; /** * Name of the SESV2 tenant. The name must be unique within the AWS account and Region. Changing the tenant name forces creation of a new tenant. * * The following arguments are optional: */ tenantName?: pulumi.Input<string>; } /** * The set of arguments for constructing a Tenant resource. */ export interface TenantArgs { /** * 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>; /** * Map of tags to assign to the tenant. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Name of the SESV2 tenant. The name must be unique within the AWS account and Region. Changing the tenant name forces creation of a new tenant. * * The following arguments are optional: */ tenantName: pulumi.Input<string>; }