virtual_clusters

Creates, updates, deletes or gets a virtual_cluster resource or lists virtual_clusters in a region

Overview

Name	virtual_clusters
Type	Resource
Description	Resource Schema of AWS::EMRContainers::VirtualCluster Type
Id	awscc.emrcontainers.virtual_clusters

Fields

get (all properties)

Name	Datatype	Description
arn	string
▶container_provider	object	Container provider of the virtual cluster.
id	string	Id of the virtual cluster.
name	string	Name of the virtual cluster.
▶tags	array	An array of key-value pairs to apply to this virtual cluster.
security_configuration_id	string	The ID of the security configuration.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Id of the virtual cluster.
region	string	AWS region.

For more information, see AWS::EMRContainers::VirtualCluster.

Methods

Name	Resource	Accessible by	Required Params
create_resource	virtual_clusters	INSERT	Name, ContainerProvider, region
delete_resource	virtual_clusters	DELETE	Identifier, region
update_resource	virtual_clusters	UPDATE	Identifier, PatchDocument, region
list_resources	virtual_clusters_list_only	SELECT	region
get_resource	virtual_clusters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual virtual_cluster.

SELECT
  region,
  arn,
  container_provider,
  id,
  name,
  tags,
  security_configuration_id
FROM awscc.emrcontainers.virtual_clusters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all virtual_clusters in a region.

SELECT
  region,
  id
FROM awscc.emrcontainers.virtual_clusters_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.emrcontainers.virtual_clusters (
  ContainerProvider,
  Name,
  region
)
SELECT
  '{{ container_provider }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.emrcontainers.virtual_clusters (
  ContainerProvider,
  Name,
  Tags,
  SecurityConfigurationId,
  region
)
SELECT
  '{{ container_provider }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ security_configuration_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: virtual_cluster
    props:
      - name: container_provider
        value:
          type: '{{ type }}'
          id: '{{ id }}'
          info:
            eks_info:
              namespace: '{{ namespace }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: security_configuration_id
        value: '{{ security_configuration_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.emrcontainers.virtual_clusters
SET PatchDocument = string('{{ {
    "Tags": tags,
    "SecurityConfigurationId": security_configuration_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.emrcontainers.virtual_clusters
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

emr-containers:CreateVirtualCluster,
emr-containers:TagResource,
iam:CreateServiceLinkedRole

Read

emr-containers:DescribeVirtualCluster

Delete

emr-containers:DeleteVirtualCluster,
emr-containers:DescribeVirtualCluster

List

emr-containers:ListVirtualClusters

Update

emr-containers:DescribeVirtualCluster,
emr-containers:ListTagsForResource,
emr-containers:TagResource,
emr-containers:UntagResource