Manages an AWS SESv2 (Simple Email V2) Tenant.
Example Usage
Basic Usage
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 pulumi
import pulumi_aws as aws
example = aws.sesv2.Tenant("example",
tenant_name="example-tenant",
tags={
"Environment": "test",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sesv2.NewTenant(ctx, "example", &sesv2.TenantArgs{
TenantName: pulumi.String("example-tenant"),
Tags: pulumi.StringMap{
"Environment": pulumi.String("test"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SesV2.Tenant("example", new()
{
TenantName = "example-tenant",
Tags =
{
{ "Environment", "test" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.Tenant;
import com.pulumi.aws.sesv2.TenantArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Tenant("example", TenantArgs.builder()
.tenantName("example-tenant")
.tags(Map.of("Environment", "test"))
.build());
}
}
resources:
example:
type: aws:sesv2:Tenant
properties:
tenantName: example-tenant
tags:
Environment: test
Create Tenant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Tenant(name: string, args: TenantArgs, opts?: CustomResourceOptions);@overload
def Tenant(resource_name: str,
args: TenantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Tenant(resource_name: str,
opts: Optional[ResourceOptions] = None,
tenant_name: Optional[str] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewTenant(ctx *Context, name string, args TenantArgs, opts ...ResourceOption) (*Tenant, error)public Tenant(string name, TenantArgs args, CustomResourceOptions? opts = null)
public Tenant(String name, TenantArgs args)
public Tenant(String name, TenantArgs args, CustomResourceOptions options)
type: aws:sesv2:Tenant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TenantArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TenantArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TenantArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TenantArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TenantArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var tenantResource = new Aws.SesV2.Tenant("tenantResource", new()
{
TenantName = "string",
Region = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := sesv2.NewTenant(ctx, "tenantResource", &sesv2.TenantArgs{
TenantName: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var tenantResource = new Tenant("tenantResource", TenantArgs.builder()
.tenantName("string")
.region("string")
.tags(Map.of("string", "string"))
.build());
tenant_resource = aws.sesv2.Tenant("tenantResource",
tenant_name="string",
region="string",
tags={
"string": "string",
})
const tenantResource = new aws.sesv2.Tenant("tenantResource", {
tenantName: "string",
region: "string",
tags: {
string: "string",
},
});
type: aws:sesv2:Tenant
properties:
region: string
tags:
string: string
tenantName: string
Tenant Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Tenant resource accepts the following input properties:
- Tenant
Name 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:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Map of tags to assign to the tenant.
- Tenant
Name 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:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Map of tags to assign to the tenant.
- tenant
Name 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:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Map of tags to assign to the tenant.
- tenant
Name 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:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Map of tags to assign to the tenant.
- tenant_
name str 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:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Map of tags to assign to the tenant.
- tenant
Name 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:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Map of tags to assign to the tenant.
Outputs
All input properties are implicitly available as output properties. Additionally, the Tenant resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Sending
Status string - Current sending status of the tenant.
- Dictionary<string, string>
- Map of tags assigned to the tenant, including provider default tags.
- Tenant
Arn string - ARN of the Tenant.
- Tenant
Id string - ID of the Tenant.
- Id string
- The provider-assigned unique ID for this managed resource.
- Sending
Status string - Current sending status of the tenant.
- map[string]string
- Map of tags assigned to the tenant, including provider default tags.
- Tenant
Arn string - ARN of the Tenant.
- Tenant
Id string - ID of the Tenant.
- id String
- The provider-assigned unique ID for this managed resource.
- sending
Status String - Current sending status of the tenant.
- Map<String,String>
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn String - ARN of the Tenant.
- tenant
Id String - ID of the Tenant.
- id string
- The provider-assigned unique ID for this managed resource.
- sending
Status string - Current sending status of the tenant.
- {[key: string]: string}
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn string - ARN of the Tenant.
- tenant
Id string - ID of the Tenant.
- id str
- The provider-assigned unique ID for this managed resource.
- sending_
status str - Current sending status of the tenant.
- Mapping[str, str]
- Map of tags assigned to the tenant, including provider default tags.
- tenant_
arn str - ARN of the Tenant.
- tenant_
id str - ID of the Tenant.
- id String
- The provider-assigned unique ID for this managed resource.
- sending
Status String - Current sending status of the tenant.
- Map<String>
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn String - ARN of the Tenant.
- tenant
Id String - ID of the Tenant.
Look up Existing Tenant Resource
Get an existing Tenant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TenantState, opts?: CustomResourceOptions): Tenant@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
region: Optional[str] = None,
sending_status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
tenant_arn: Optional[str] = None,
tenant_id: Optional[str] = None,
tenant_name: Optional[str] = None) -> Tenantfunc GetTenant(ctx *Context, name string, id IDInput, state *TenantState, opts ...ResourceOption) (*Tenant, error)public static Tenant Get(string name, Input<string> id, TenantState? state, CustomResourceOptions? opts = null)public static Tenant get(String name, Output<String> id, TenantState state, CustomResourceOptions options)resources: _: type: aws:sesv2:Tenant get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Sending
Status string - Current sending status of the tenant.
- Dictionary<string, string>
- Map of tags to assign to the tenant.
- Dictionary<string, string>
- Map of tags assigned to the tenant, including provider default tags.
- Tenant
Arn string - ARN of the Tenant.
- Tenant
Id string - ID of the Tenant.
- Tenant
Name 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:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Sending
Status string - Current sending status of the tenant.
- map[string]string
- Map of tags to assign to the tenant.
- map[string]string
- Map of tags assigned to the tenant, including provider default tags.
- Tenant
Arn string - ARN of the Tenant.
- Tenant
Id string - ID of the Tenant.
- Tenant
Name 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:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- sending
Status String - Current sending status of the tenant.
- Map<String,String>
- Map of tags to assign to the tenant.
- Map<String,String>
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn String - ARN of the Tenant.
- tenant
Id String - ID of the Tenant.
- tenant
Name 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:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- sending
Status string - Current sending status of the tenant.
- {[key: string]: string}
- Map of tags to assign to the tenant.
- {[key: string]: string}
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn string - ARN of the Tenant.
- tenant
Id string - ID of the Tenant.
- tenant
Name 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:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- sending_
status str - Current sending status of the tenant.
- Mapping[str, str]
- Map of tags to assign to the tenant.
- Mapping[str, str]
- Map of tags assigned to the tenant, including provider default tags.
- tenant_
arn str - ARN of the Tenant.
- tenant_
id str - ID of the Tenant.
- tenant_
name str 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:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- sending
Status String - Current sending status of the tenant.
- Map<String>
- Map of tags to assign to the tenant.
- Map<String>
- Map of tags assigned to the tenant, including provider default tags.
- tenant
Arn String - ARN of the Tenant.
- tenant
Id String - ID of the Tenant.
- tenant
Name 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:
Import
Using pulumi import, import an SESv2 Tenant using the tenant_name. For example:
$ pulumi import aws:sesv2/tenant:Tenant example example-tenant
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
