license_server_endpoints

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

Overview

Name	license_server_endpoints
Type	Resource
Id	aws.license_manager_user_subscriptions.license_server_endpoints

Fields

The following fields are returned by SELECT queries:

list_license_server_endpoints

Name	Datatype	Description
creation_time	string (date-time)	The timestamp when License Manager created the license server endpoint.
identity_provider_arn	string	The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint.
license_server_endpoint_arn	string	The ARN of the ServerEndpoint resource for the RDS license server. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{1,63}:[a-z0-9-.]{1,63}:[a-z0-9-.]{1,63}:[a-zA-Z0-9-.]{1,510}/[a-zA-Z0-9-.]{1,510}</code>)
license_server_endpoint_id	string	The ID of the license server endpoint.
license_server_endpoint_provisioning_status	string	The current state of the provisioning process for the RDS license server endpoint (PROVISIONING, PROVISIONING_FAILED, PROVISIONED, DELETING, DELETION_FAILED, DELETED)
license_servers	array	An array of LicenseServer resources that represent the license servers that are accessed through this endpoint.
server_endpoint	object	The ServerEndpoint resource contains the network address of the RDS license server endpoint.
server_type	string	The type of license server. (RDS_SAL)
status_message	string	The message associated with the provisioning status, if there is one.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_license_server_endpoints	select	region		List the Remote Desktop Services (RDS) License Server endpoints
create_license_server_endpoint	insert	region, IdentityProviderArn, LicenseServerSettings		Creates a network endpoint for the Remote Desktop Services (RDS) license server.
delete_license_server_endpoint	delete	region		Deletes a LicenseServerEndpoint resource.

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_license_server_endpoints

List the Remote Desktop Services (RDS) License Server endpoints

SELECT
creation_time,
identity_provider_arn,
license_server_endpoint_arn,
license_server_endpoint_id,
license_server_endpoint_provisioning_status,
license_servers,
server_endpoint,
server_type,
status_message
FROM aws.license_manager_user_subscriptions.license_server_endpoints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_license_server_endpoint

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

INSERT INTO aws.license_manager_user_subscriptions.license_server_endpoints (
IdentityProviderArn,
LicenseServerSettings,
Tags,
region
)
SELECT 
'{{ IdentityProviderArn }}' /* required */,
'{{ LicenseServerSettings }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
identity_provider_arn,
license_server_endpoint_arn
;

Manifest

# Description fields are for documentation purposes
- name: license_server_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_server_endpoints resource.
  - name: IdentityProviderArn
    value: "{{ IdentityProviderArn }}"
  - name: LicenseServerSettings
    description: |
      The settings to configure your license server.
    value:
      ServerType: "{{ ServerType }}"
      ServerSettings:
        RdsSalSettings:
          RdsSalCredentialsProvider:
            SecretsManagerCredentialsProvider:
              SecretId: "{{ SecretId }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_license_server_endpoint

Deletes a LicenseServerEndpoint resource.

DELETE FROM aws.license_manager_user_subscriptions.license_server_endpoints
WHERE region = '{{ region }}' --required
;