saml_properties
Creates, updates, deletes, gets or lists a saml_properties resource.
Overview
| Name | saml_properties |
| Type | Resource |
| Id | aws.workspaces.saml_properties |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
modify_saml_properties | update | region, ResourceId | Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider. |
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) |
UPDATE examples
- modify_saml_properties
Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
UPDATE aws.workspaces.saml_properties
SET
ResourceId = '{{ ResourceId }}',
SamlProperties = '{{ SamlProperties }}',
PropertiesToDelete = '{{ PropertiesToDelete }}'
WHERE
region = '{{ region }}' --required
AND ResourceId = '{{ ResourceId }}' --required;