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	aws.emrcontainers.virtual_clusters

Fields

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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, ContainerProvider, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all virtual_clusters in a region.

SELECT
region,
arn,
container_provider,
id,
name,
tags
FROM aws.emrcontainers.virtual_clusters
WHERE region = 'us-east-1';

Gets all properties from an individual virtual_cluster.

SELECT
region,
arn,
container_provider,
id,
name,
tags
FROM aws.emrcontainers.virtual_clusters
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

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 aws.emrcontainers.virtual_clusters (
 ContainerProvider,
 Name,
 region
)
SELECT 
'{{ ContainerProvider }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.emrcontainers.virtual_clusters (
 ContainerProvider,
 Name,
 Tags,
 region
)
SELECT 
 '{{ ContainerProvider }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ 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: ContainerProvider
        value:
          Type: '{{ Type }}'
          Id: '{{ Id }}'
          Info:
            EksInfo:
              Namespace: '{{ Namespace }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.emrcontainers.virtual_clusters
WHERE data__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

List

emr-containers:ListVirtualClusters

Update

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