saml_providers

Creates, updates, deletes or gets a saml_provider resource or lists saml_providers in a region

Overview

Name	saml_providers
Type	Resource
Description	Resource Type definition for AWS::IAM::SAMLProvider
Id	awscc.iam.saml_providers

Fields

get (all properties)

Name	Datatype	Description
name	string
saml_metadata_document	string
arn	string	Amazon Resource Name (ARN) of the SAML provider
▶tags	array
assertion_encryption_mode	string	The encryption setting for the SAML provider
add_private_key	string	The private key from your external identity provider
remove_private_key	string	The Key ID of the private key to remove
▶private_key_list	array
saml_provider_uu_id	string	The unique identifier assigned to the SAML provider
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Amazon Resource Name (ARN) of the SAML provider
region	string	AWS region.

For more information, see AWS::IAM::SAMLProvider.

Methods

Name	Resource	Accessible by	Required Params
create_resource	saml_providers	INSERT	region
delete_resource	saml_providers	DELETE	Identifier, region
update_resource	saml_providers	UPDATE	Identifier, PatchDocument, region
list_resources	saml_providers_list_only	SELECT	region
get_resource	saml_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual saml_provider.

SELECT
  region,
  name,
  saml_metadata_document,
  arn,
  tags,
  assertion_encryption_mode,
  add_private_key,
  remove_private_key,
  private_key_list,
  saml_provider_uu_id
FROM awscc.iam.saml_providers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all saml_providers in a region.

SELECT
  region,
  arn
FROM awscc.iam.saml_providers_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iam.saml_providers (
  Name,
  SamlMetadataDocument,
  Tags,
  AssertionEncryptionMode,
  AddPrivateKey,
  RemovePrivateKey,
  PrivateKeyList,
  region
)
SELECT
  '{{ name }}',
  '{{ saml_metadata_document }}',
  '{{ tags }}',
  '{{ assertion_encryption_mode }}',
  '{{ add_private_key }}',
  '{{ remove_private_key }}',
  '{{ private_key_list }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iam.saml_providers (
  Name,
  SamlMetadataDocument,
  Tags,
  AssertionEncryptionMode,
  AddPrivateKey,
  RemovePrivateKey,
  PrivateKeyList,
  region
)
SELECT
  '{{ name }}',
  '{{ saml_metadata_document }}',
  '{{ tags }}',
  '{{ assertion_encryption_mode }}',
  '{{ add_private_key }}',
  '{{ remove_private_key }}',
  '{{ private_key_list }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: saml_provider
  props:
    - name: name
      value: '{{ name }}'
    - name: saml_metadata_document
      value: '{{ saml_metadata_document }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: assertion_encryption_mode
      value: '{{ assertion_encryption_mode }}'
    - name: add_private_key
      value: '{{ add_private_key }}'
    - name: remove_private_key
      value: '{{ remove_private_key }}'
    - name: private_key_list
      value:
        - key_id: '{{ key_id }}'
          timestamp: '{{ timestamp }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iam.saml_providers
SET PatchDocument = string('{{ {
    "SamlMetadataDocument": saml_metadata_document,
    "Tags": tags,
    "AssertionEncryptionMode": assertion_encryption_mode,
    "PrivateKeyList": private_key_list
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iam.saml_providers
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

iam:CreateSAMLProvider,
iam:GetSAMLProvider,
iam:TagSAMLProvider

Read

iam:GetSAMLProvider

Update

iam:UpdateSAMLProvider,
iam:GetSAMLProvider,
iam:TagSAMLProvider,
iam:ListSAMLProviderTags,
iam:UntagSAMLProvider

Delete

iam:DeleteSAMLProvider

List

iam:ListSAMLProviders,
iam:GetSAMLProvider