domain_endpoint_options

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

Overview

Name	domain_endpoint_options
Type	Resource
Id	aws.cloudsearch.domain_endpoint_options

Fields

The following fields are returned by SELECT queries:

describe_domain_endpoint_options

Name	Datatype	Description
options	string	The domain endpoint options configured for the domain.
status	string	The status of the configured domain endpoint options.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_endpoint_options	select	DomainName, region	Deployed	Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
update_domain_endpoint_options	update	DomainName, DomainEndpointOptions, region		Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

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
DomainEndpointOptions	object	Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.
DomainName	string	A string that represents the name of a domain.
region	string	AWS region (default: us-east-1)
Deployed	boolean	Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

SELECT examples

describe_domain_endpoint_options

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

SELECT
options,
status
FROM aws.cloudsearch.domain_endpoint_options
WHERE DomainName = '{{ DomainName }}' -- required
AND region = '{{ region }}' -- required
AND Deployed = '{{ Deployed }}'
;

UPDATE examples

update_domain_endpoint_options

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

UPDATE aws.cloudsearch.domain_endpoint_options
SET 
-- No updatable properties
WHERE 
DomainName = '{{ DomainName }}' --required
AND DomainEndpointOptions = '{{ DomainEndpointOptions }}' --required
AND region = '{{ region }}' --required
RETURNING
options,
status;