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	awscc.workspacesweb.identity_providers

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
identity_provider_arn	string
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::IdentityProvider.

Methods

Name	Resource	Accessible by	Required Params
create_resource	identity_providers	INSERT	IdentityProviderDetails, IdentityProviderName, IdentityProviderType, region
delete_resource	identity_providers	DELETE	Identifier, region
update_resource	identity_providers	UPDATE	Identifier, PatchDocument, region
list_resources	identity_providers_list_only	SELECT	region
get_resource	identity_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual identity_provider.

SELECT
  region,
  identity_provider_arn,
  identity_provider_details,
  identity_provider_name,
  identity_provider_type,
  portal_arn,
  tags
FROM awscc.workspacesweb.identity_providers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ identity_provider_arn }}';

list (identifiers only)

Lists all identity_providers in a region.

SELECT
  region,
  identity_provider_arn
FROM awscc.workspacesweb.identity_providers_list_only
WHERE
  region = 'us-east-1';

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 awscc.workspacesweb.identity_providers (
  IdentityProviderDetails,
  IdentityProviderName,
  IdentityProviderType,
  region
)
SELECT
  '{{ identity_provider_details }}',
  '{{ identity_provider_name }}',
  '{{ identity_provider_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.identity_providers (
  IdentityProviderDetails,
  IdentityProviderName,
  IdentityProviderType,
  PortalArn,
  Tags,
  region
)
SELECT
  '{{ identity_provider_details }}',
  '{{ identity_provider_name }}',
  '{{ identity_provider_type }}',
  '{{ portal_arn }}',
  '{{ tags }}',
  '{{ 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: identity_provider_details
        value: {}
      - name: identity_provider_name
        value: '{{ identity_provider_name }}'
      - name: identity_provider_type
        value: '{{ identity_provider_type }}'
      - name: portal_arn
        value: '{{ portal_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.identity_providers
SET PatchDocument = string('{{ {
    "IdentityProviderDetails": identity_provider_details,
    "IdentityProviderName": identity_provider_name,
    "IdentityProviderType": identity_provider_type,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identity_provider_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.identity_providers
WHERE
  Identifier = '{{ identity_provider_arn }}' 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