tenant_resources

Creates, updates, deletes, gets or lists a tenant_resources resource.

Overview

Name	tenant_resources
Type	Resource
Id	aws.sesv2.tenant_resources

Fields

The following fields are returned by SELECT queries:

list_tenant_resources

Name	Datatype	Description
resource_arn	string	The Amazon Resource Name (ARN) of the resource associated with the tenant.
resource_type	string	The type of resource associated with the tenant. Valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE. (EMAIL_IDENTITY, CONFIGURATION_SET, EMAIL_TEMPLATE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tenant_resources	select	region		List all resources associated with a specific tenant. This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.
create_tenant_resource_association	insert	region, TenantName, ResourceArn		Associate a resource with a tenant. Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant. A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.
delete_tenant_resource_association	delete	region		Delete an association between a tenant and a resource. When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_tenant_resources

List all resources associated with a specific tenant. This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.

SELECT
resource_arn,
resource_type
FROM aws.sesv2.tenant_resources
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_tenant_resource_association

Associate a resource with a tenant. Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant. A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.

INSERT INTO aws.sesv2.tenant_resources (
TenantName,
ResourceArn,
region
)
SELECT 
'{{ TenantName }}' /* required */,
'{{ ResourceArn }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: tenant_resources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tenant_resources resource.
  - name: TenantName
    value: "{{ TenantName }}"
    description: |
      The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
  - name: ResourceArn
    value: "{{ ResourceArn }}"

DELETE examples

delete_tenant_resource_association

Delete an association between a tenant and a resource. When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.

DELETE FROM aws.sesv2.tenant_resources
WHERE region = '{{ region }}' --required
;