identity_providers

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

Overview

Name	identity_providers
Type	Resource
Id	aws.license_manager_user_subscriptions.identity_providers

Fields

The following fields are returned by SELECT queries:

list_identity_providers

Name	Datatype	Description
failure_message	string	The failure message associated with an identity provider.
identity_provider	object	Refers to an identity provider.
identity_provider_arn	string	The Amazon Resource Name (ARN) of the identity provider. (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>)
owner_account_id	string	The AWS Account ID of the owner of this resource.
product	string	The name of the user-based subscription product.
settings	object	The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
status	string	The status of the identity provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_identity_providers	select	region		Lists the Active Directory identity providers for user-based subscriptions.
register_identity_provider	insert	region, IdentityProvider		Registers an identity provider for user-based subscriptions.
update_identity_provider_settings	update	region, UpdateSettings		Updates additional product configuration settings for the registered identity provider.
deregister_identity_provider	delete	region		Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

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_identity_providers

Lists the Active Directory identity providers for user-based subscriptions.

SELECT
failure_message,
identity_provider,
identity_provider_arn,
owner_account_id,
product,
settings,
status
FROM aws.license_manager_user_subscriptions.identity_providers
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_identity_provider

Registers an identity provider for user-based subscriptions.

INSERT INTO aws.license_manager_user_subscriptions.identity_providers (
IdentityProvider,
Product,
Settings,
Tags,
region
)
SELECT 
'{{ IdentityProvider }}' /* required */,
'{{ Product }}',
'{{ Settings }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
identity_provider_summary
;

Manifest

# Description fields are for documentation purposes
- name: identity_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the identity_providers resource.
  - name: IdentityProvider
    description: |
      Refers to an identity provider.
    value:
      ActiveDirectoryIdentityProvider:
        DirectoryId: "{{ DirectoryId }}"
        ActiveDirectorySettings:
          DomainName: "{{ DomainName }}"
          DomainIpv4List:
            - "{{ DomainIpv4List }}"
          DomainIpv6List:
            - "{{ DomainIpv6List }}"
          DomainCredentialsProvider:
            SecretsManagerCredentialsProvider:
              SecretId: "{{ SecretId }}"
          DomainNetworkSettings:
            Subnets:
              - "{{ Subnets }}"
        ActiveDirectoryType: "{{ ActiveDirectoryType }}"
        IsSharedActiveDirectory: {{ IsSharedActiveDirectory }}
  - name: Product
    value: "{{ Product }}"
  - name: Settings
    description: |
      The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.
    value:
      Subnets:
        - "{{ Subnets }}"
      SecurityGroupId: "{{ SecurityGroupId }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_identity_provider_settings

Updates additional product configuration settings for the registered identity provider.

UPDATE aws.license_manager_user_subscriptions.identity_providers
SET 
IdentityProvider = '{{ IdentityProvider }}',
Product = '{{ Product }}',
IdentityProviderArn = '{{ IdentityProviderArn }}',
UpdateSettings = '{{ UpdateSettings }}'
WHERE 
region = '{{ region }}' --required
AND UpdateSettings = '{{ UpdateSettings }}' --required
RETURNING
identity_provider_summary;

DELETE examples

deregister_identity_provider

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

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