identity_providers

Creates, updates, deletes or gets an identity_provider resource or lists identity_providers in a region

Overview

Name	identity_providers
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Id	aws.workspacesweb.identity_providers

Fields

Name	Datatype	Description
identity_provider_arn	string
identity_provider_details	object
identity_provider_name	string
identity_provider_type	string
portal_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdentityProviderDetails, IdentityProviderName, IdentityProviderType, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all identity_providers in a region.

SELECT
region,
identity_provider_arn,
identity_provider_details,
identity_provider_name,
identity_provider_type,
portal_arn
FROM aws.workspacesweb.identity_providers
WHERE region = 'us-east-1';

Gets all properties from an individual identity_provider.

SELECT
region,
identity_provider_arn,
identity_provider_details,
identity_provider_name,
identity_provider_type,
portal_arn
FROM aws.workspacesweb.identity_providers
WHERE region = 'us-east-1' AND data__Identifier = '<IdentityProviderArn>';

INSERT example

Use the following StackQL query and manifest file to create a new identity_provider resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.workspacesweb.identity_providers (
 IdentityProviderDetails,
 IdentityProviderName,
 IdentityProviderType,
 region
)
SELECT 
'{{ IdentityProviderDetails }}',
 '{{ IdentityProviderName }}',
 '{{ IdentityProviderType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.identity_providers (
 IdentityProviderDetails,
 IdentityProviderName,
 IdentityProviderType,
 PortalArn,
 region
)
SELECT 
 '{{ IdentityProviderDetails }}',
 '{{ IdentityProviderName }}',
 '{{ IdentityProviderType }}',
 '{{ PortalArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_provider
    props:
      - name: IdentityProviderDetails
        value: {}
      - name: IdentityProviderName
        value: '{{ IdentityProviderName }}'
      - name: IdentityProviderType
        value: '{{ IdentityProviderType }}'
      - name: PortalArn
        value: '{{ PortalArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.identity_providers
WHERE data__Identifier = '<IdentityProviderArn>'
AND region = 'us-east-1';

Permissions

To operate on the identity_providers resource, the following permissions are required:

Create

workspaces-web:CreateIdentityProvider,
workspaces-web:GetIdentityProvider,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource

Read

workspaces-web:GetIdentityProvider,
workspaces-web:ListIdentityProviders,
workspaces-web:ListTagsForResource

Update

workspaces-web:UpdateIdentityProvider,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetIdentityProvider,
workspaces-web:ListIdentityProviders,
workspaces-web:ListTagsForResource

Delete

workspaces-web:GetIdentityProvider,
workspaces-web:DeleteIdentityProvider

List

workspaces-web:ListIdentityProviders