security_configurations

Creates, updates, deletes, gets or lists a security_configurations resource.

Overview

Name	security_configurations
Type	Resource
Id	aws.emr_containers.security_configurations

Fields

The following fields are returned by SELECT queries:

describe_security_configuration

Name	Datatype	Description
id	string	The ID of the security configuration. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the security configuration. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN (Amazon Resource Name) of the security configuration. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/securityconfigurations/[0-9a-zA-Z]+$</code>)
created_at	string (date-time)	The date and time that the job run was created.
created_by	string	The user who created the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+$</code>)
security_configuration_data	object	Configurations related to the security configuration for the request.
tags	object	The tags to assign to the security configuration.

list_security_configurations

Name	Datatype	Description
id	string	The ID of the security configuration. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the security configuration. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN (Amazon Resource Name) of the security configuration. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/securityconfigurations/[0-9a-zA-Z]+$</code>)
created_at	string (date-time)	The date and time that the job run was created.
created_by	string	The user who created the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+$</code>)
security_configuration_data	object	Configurations related to the security configuration for the request.
tags	object	The tags to assign to the security configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_security_configuration	select	security_configuration_id, region		Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
list_security_configurations	select	region	createdAfter, createdBefore, maxResults, nextToken	Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
create_security_configuration	insert	region, clientToken, name, securityConfigurationData		Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.
delete_security_configuration	delete	security_configuration_id, region		Deletes a security configuration.

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)
security_configuration_id	string	The ID of the security configuration to delete.
createdAfter	string (date-time)	The date and time after which the security configuration was created.
createdBefore	string (date-time)	The date and time before which the security configuration was created.
maxResults	integer	The maximum number of security configurations the operation can list.
nextToken	string	The token for the next set of security configurations to return.

SELECT examples

describe_security_configuration

Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

SELECT
id,
name,
arn,
created_at,
created_by,
security_configuration_data,
tags
FROM aws.emr_containers.security_configurations
WHERE security_configuration_id = '{{ security_configuration_id }}' -- required
AND region = '{{ region }}' -- required
;

list_security_configurations

Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

SELECT
id,
name,
arn,
created_at,
created_by,
security_configuration_data,
tags
FROM aws.emr_containers.security_configurations
WHERE region = '{{ region }}' -- required
AND createdAfter = '{{ createdAfter }}'
AND createdBefore = '{{ createdBefore }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_security_configuration

Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

INSERT INTO aws.emr_containers.security_configurations (
clientToken,
name,
containerProvider,
securityConfigurationData,
tags,
region
)
SELECT 
'{{ clientToken }}' /* required */,
'{{ name }}' /* required */,
'{{ containerProvider }}',
'{{ securityConfigurationData }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn
;

Manifest

# Description fields are for documentation purposes
- name: security_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the security_configurations resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: containerProvider
    description: |
      The information about the container provider.
    value:
      type_: "{{ type_ }}"
      id: "{{ id }}"
      info:
        eksInfo:
          namespace: "{{ namespace }}"
          nodeLabel: "{{ nodeLabel }}"
  - name: securityConfigurationData
    description: |
      Configurations related to the security configuration for the request.
    value:
      authorizationConfiguration:
        lakeFormationConfiguration:
          authorizedSessionTagValue: "{{ authorizedSessionTagValue }}"
          secureNamespaceInfo:
            clusterId: "{{ clusterId }}"
            namespace: "{{ namespace }}"
          queryEngineRoleArn: "{{ queryEngineRoleArn }}"
        encryptionConfiguration:
          inTransitEncryptionConfiguration:
            tlsCertificateConfiguration:
              certificateProviderType: "{{ certificateProviderType }}"
              publicCertificateSecretArn: "{{ publicCertificateSecretArn }}"
              privateCertificateSecretArn: "{{ privateCertificateSecretArn }}"
      authenticationConfiguration:
        identityCenterConfiguration:
          enableIdentityCenter: {{ enableIdentityCenter }}
          identityCenterApplicationAssignmentRequired: {{ identityCenterApplicationAssignmentRequired }}
          identityCenterInstanceARN: "{{ identityCenterInstanceARN }}"
          emrIdentityCenterApplicationARN: "{{ emrIdentityCenterApplicationARN }}"
        iamConfiguration:
          systemRole: "{{ systemRole }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_security_configuration

Deletes a security configuration.

DELETE FROM aws.emr_containers.security_configurations
WHERE security_configuration_id = '{{ security_configuration_id }}' --required
AND region = '{{ region }}' --required
;