authentication_profiles

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

Overview

Name	authentication_profiles
Type	Resource
Id	aws.redshift.authentication_profiles

Fields

The following fields are returned by SELECT queries:

describe_authentication_profiles

Name	Datatype	Description
authentication_profile_content	string	The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authentication_profile_name	string	The name of the authentication profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_authentication_profiles	select	region	AuthenticationProfileName	Describes an authentication profile.
create_authentication_profile	insert	AuthenticationProfileName, AuthenticationProfileContent, region		Creates an authentication profile with the specified parameters.
modify_authentication_profile	update	AuthenticationProfileName, AuthenticationProfileContent, region		Modifies an authentication profile.
delete_authentication_profile	delete	AuthenticationProfileName, region		Deletes an authentication profile.

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
AuthenticationProfileContent	string	The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
AuthenticationProfileName	string	The name of the authentication profile to delete.
region	string	AWS region (default: us-east-1)
AuthenticationProfileName	string	The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

SELECT examples

describe_authentication_profiles

Describes an authentication profile.

SELECT
authentication_profile_content,
authentication_profile_name
FROM aws.redshift.authentication_profiles
WHERE region = '{{ region }}' -- required
AND AuthenticationProfileName = '{{ AuthenticationProfileName }}'
;

INSERT examples

create_authentication_profile

Creates an authentication profile with the specified parameters.

INSERT INTO aws.redshift.authentication_profiles (
AuthenticationProfileName,
AuthenticationProfileContent,
region
)
SELECT 
'{{ AuthenticationProfileName }}',
'{{ AuthenticationProfileContent }}',
'{{ region }}'
RETURNING
authentication_profile_content,
authentication_profile_name
;

Manifest

# Description fields are for documentation purposes
- name: authentication_profiles
props:
  - name: AuthenticationProfileName
    value: "{{ AuthenticationProfileName }}"
    description: Required parameter for the authentication_profiles resource.
  - name: AuthenticationProfileContent
    value: "{{ AuthenticationProfileContent }}"
    description: Required parameter for the authentication_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the authentication_profiles resource.

UPDATE examples

modify_authentication_profile

Modifies an authentication profile.

UPDATE aws.redshift.authentication_profiles
SET 
-- No updatable properties
WHERE 
AuthenticationProfileName = '{{ AuthenticationProfileName }}' --required
AND AuthenticationProfileContent = '{{ AuthenticationProfileContent }}' --required
AND region = '{{ region }}' --required
RETURNING
authentication_profile_content,
authentication_profile_name;

DELETE examples

delete_authentication_profile

Deletes an authentication profile.

DELETE FROM aws.redshift.authentication_profiles
WHERE AuthenticationProfileName = '{{ AuthenticationProfileName }}' --required
AND region = '{{ region }}' --required
;