service_settings

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

Overview

Name	service_settings
Type	Resource
Id	aws.license_manager.service_settings

Fields

The following fields are returned by SELECT queries:

get_service_settings

Name	Datatype	Description
cross_region_discovery_home_region	string	Cross region discovery home region.
cross_region_discovery_source_regions	array	Cross region discovery source regions.
enable_cross_accounts_discovery	boolean	Indicates whether cross-account discovery is enabled.
license_manager_resource_share_arn	string	Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.
organization_configuration	object	Indicates whether Organizations is integrated with License Manager for cross-account discovery.
s3_bucket_arn	string	Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
service_status	object	Service status.
sns_topic_arn	string	SNS topic configured to receive notifications from License Manager.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_settings	select	region		Gets the License Manager settings for the current Region.
update_service_settings	update	region		Updates License Manager settings for the current Region.

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

get_service_settings

Gets the License Manager settings for the current Region.

SELECT
cross_region_discovery_home_region,
cross_region_discovery_source_regions,
enable_cross_accounts_discovery,
license_manager_resource_share_arn,
organization_configuration,
s3_bucket_arn,
service_status,
sns_topic_arn
FROM aws.license_manager.service_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_service_settings

Updates License Manager settings for the current Region.

UPDATE aws.license_manager.service_settings
SET 
S3BucketArn = '{{ S3BucketArn }}',
SnsTopicArn = '{{ SnsTopicArn }}',
OrganizationConfiguration = '{{ OrganizationConfiguration }}',
EnableCrossAccountsDiscovery = {{ EnableCrossAccountsDiscovery }},
EnabledDiscoverySourceRegions = '{{ EnabledDiscoverySourceRegions }}'
WHERE 
region = '{{ region }}' --required;