availability_configurations

Creates, updates, deletes, gets or lists an availability_configurations resource.

Overview

Name	availability_configurations
Type	Resource
Id	aws.workmail.availability_configurations

Fields

The following fields are returned by SELECT queries:

list_availability_configurations

Name	Datatype	Description
date_created	string (date-time)	The date and time at which the availability configuration was created.
date_modified	string (date-time)	The date and time at which the availability configuration was last modified.
domain_name	string	Displays the domain to which the provider applies. (pattern: <code>[a-zA-Z0-9.-]+</code>)
ews_provider	object	If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.
lambda_provider	object	If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.
provider_type	string	Displays the provider type that applies to this domain. (EWS, LAMBDA)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_availability_configurations	select	region		List all the AvailabilityConfiguration's for the given WorkMail organization.
create_availability_configuration	insert	region, OrganizationId, DomainName		Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
update_availability_configuration	update	region, OrganizationId, DomainName		Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
delete_availability_configuration	delete	region		Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

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_availability_configurations

List all the AvailabilityConfiguration's for the given WorkMail organization.

SELECT
date_created,
date_modified,
domain_name,
ews_provider,
lambda_provider,
provider_type
FROM aws.workmail.availability_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_availability_configuration

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

INSERT INTO aws.workmail.availability_configurations (
ClientToken,
OrganizationId,
DomainName,
EwsProvider,
LambdaProvider,
region
)
SELECT 
'{{ ClientToken }}',
'{{ OrganizationId }}' /* required */,
'{{ DomainName }}' /* required */,
'{{ EwsProvider }}',
'{{ LambdaProvider }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: availability_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the availability_configurations resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      An idempotent token that ensures that an API request is executed only once.
  - name: OrganizationId
    value: "{{ OrganizationId }}"
    description: |
      The WorkMail organization for which the AvailabilityConfiguration will be created.
  - name: DomainName
    value: "{{ DomainName }}"
    description: |
      The domain to which the provider applies.
  - name: EwsProvider
    description: |
      Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
    value:
      EwsEndpoint: "{{ EwsEndpoint }}"
      EwsUsername: "{{ EwsUsername }}"
      EwsPassword: "{{ EwsPassword }}"
  - name: LambdaProvider
    description: |
      Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.
    value:
      LambdaArn: "{{ LambdaArn }}"

UPDATE examples

update_availability_configuration

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

UPDATE aws.workmail.availability_configurations
SET 
OrganizationId = '{{ OrganizationId }}',
DomainName = '{{ DomainName }}',
EwsProvider = '{{ EwsProvider }}',
LambdaProvider = '{{ LambdaProvider }}'
WHERE 
region = '{{ region }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required
AND DomainName = '{{ DomainName }}' --required;

DELETE examples

delete_availability_configuration

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

DELETE FROM aws.workmail.availability_configurations
WHERE region = '{{ region }}' --required
;