subdomain

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

Overview

Name	subdomain
Type	Resource
Id	sumologic.account.subdomain

Fields

The following fields are returned by SELECT queries:

get

The subdomain's definition.

Name	Datatype	Description
created_at	string (date-time)	Creation timestamp in UTC in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. (wire: createdAt)
created_by	string	Identifier of the user who created the resource. (wire: createdBy)
modified_at	string (date-time)	Last modification timestamp in UTC. (wire: modifiedAt)
modified_by	string	Identifier of the user who last modified the resource. (wire: modifiedBy)
subdomain	string	The new subdomain. (example: my-company)
url	string	Login URL corresponding to the subdomain. (example: https:​//your-company.sumologic.com)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	region		Get the configured subdomain.
create	insert	region, subdomain		Create a subdomain. Only the Account Owner can create a subdomain.
update	update	region, subdomain		Update a subdomain. Only the Account Owner can update the subdomain.
delete	delete	region		Delete the configured subdomain.
recover	exec	email, region		Send an email with the subdomain information for a user with the given email address.

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
email	string	Email address of the user to get subdomain information.
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

SELECT examples

get

Get the configured subdomain.

SELECT
created_at,
created_by,
modified_at,
modified_by,
subdomain,
url
FROM sumologic.account.subdomain
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples

create

Create a subdomain. Only the Account Owner can create a subdomain.

INSERT INTO sumologic.account.subdomain (
subdomain,
region
)
SELECT 
'{{ subdomain }}' /* required */,
'{{ region }}'
RETURNING
created_at,
created_by,
modified_at,
modified_by,
subdomain,
url
;

Manifest

# Description fields are for documentation purposes
- name: subdomain
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the subdomain resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: |
      The new subdomain.

UPDATE examples

update

Update a subdomain. Only the Account Owner can update the subdomain.

UPDATE sumologic.account.subdomain
SET 
subdomain = '{{ subdomain }}'
WHERE 
region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
AND subdomain = '{{ subdomain }}' --required
RETURNING
created_at,
created_by,
modified_at,
modified_by,
subdomain,
url;

DELETE examples

delete

Delete the configured subdomain.

DELETE FROM sumologic.account.subdomain
WHERE region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

recover

Send an email with the subdomain information for a user with the given email address.

EXEC sumologic.account.subdomain.recover 
@email='{{ email }}' --required, 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;