managed_endpoints

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

Overview

Name	managed_endpoints
Type	Resource
Id	aws.emr_containers.managed_endpoints

Fields

The following fields are returned by SELECT queries:

describe_managed_endpoint

Name	Datatype	Description
id	string	The ID of the endpoint. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the endpoint. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN of the endpoint. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/virtualclusters/[0-9a-zA-Z]+/endpoints/[0-9a-zA-Z]+$</code>)
auth_proxy_url	string	The authentication proxy URL of the endpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*</code>)
certificate_arn	string	The certificate ARN of the endpoint. This field is under deprecation and will be removed in future. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\d{12}):certificate/.+$</code>)
certificate_authority	object	The certificate generated by emr control plane on customer behalf to secure the managed endpoint.
configuration_overrides	object	A configuration specification to be used to override existing configurations.
created_at	string (date-time)	The date and time when the endpoint was created.
execution_role_arn	string	The execution role ARN of the endpoint. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$</code>)
failure_reason	string	The reasons why the endpoint has failed. (INTERNAL_ERROR, USER_ERROR, VALIDATION_ERROR, CLUSTER_UNAVAILABLE)
release_label	string	The EMR release version to be used for the endpoint. (pattern: <code>[.-_/A-Za-z0-9]+</code>)
security_group	string	The security group configuration of the endpoint. (pattern: <code>.\S.</code>)
server_url	string	The server URL of the endpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*</code>)
state	string	The state of the endpoint. (CREATING, ACTIVE, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS)
state_details	string	Additional details of the endpoint state. (pattern: <code>.\S.</code>)
subnet_ids	array	The subnet IDs of the endpoint.
tags	object	The tags of the endpoint.
type_	string	The type of the endpoint. (pattern: <code>.\S.</code>)
virtual_cluster_id	string	The ID of the endpoint's virtual cluster. (pattern: <code>[0-9a-z]+</code>)

list_managed_endpoints

Name	Datatype	Description
id	string	The ID of the endpoint. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the endpoint. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN of the endpoint. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/virtualclusters/[0-9a-zA-Z]+/endpoints/[0-9a-zA-Z]+$</code>)
auth_proxy_url	string	The authentication proxy URL of the endpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*</code>)
certificate_arn	string	The certificate ARN of the endpoint. This field is under deprecation and will be removed in future. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\d{12}):certificate/.+$</code>)
certificate_authority	object	The certificate generated by emr control plane on customer behalf to secure the managed endpoint.
configuration_overrides	object	A configuration specification to be used to override existing configurations.
created_at	string (date-time)	The date and time when the endpoint was created.
execution_role_arn	string	The execution role ARN of the endpoint. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$</code>)
failure_reason	string	The reasons why the endpoint has failed. (INTERNAL_ERROR, USER_ERROR, VALIDATION_ERROR, CLUSTER_UNAVAILABLE)
release_label	string	The EMR release version to be used for the endpoint. (pattern: <code>[.-_/A-Za-z0-9]+</code>)
security_group	string	The security group configuration of the endpoint. (pattern: <code>.\S.</code>)
server_url	string	The server URL of the endpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*</code>)
state	string	The state of the endpoint. (CREATING, ACTIVE, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS)
state_details	string	Additional details of the endpoint state. (pattern: <code>.\S.</code>)
subnet_ids	array	The subnet IDs of the endpoint.
tags	object	The tags of the endpoint.
type_	string	The type of the endpoint. (pattern: <code>.\S.</code>)
virtual_cluster_id	string	The ID of the endpoint's virtual cluster. (pattern: <code>[0-9a-z]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_managed_endpoint	select	endpoint_id, virtual_cluster_id, region		Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
list_managed_endpoints	select	virtual_cluster_id, region	createdBefore, createdAfter, types, states, maxResults, nextToken	Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
create_managed_endpoint	insert	virtual_cluster_id, region, name, type, releaseLabel, executionRoleArn, clientToken		Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
delete_managed_endpoint	delete	endpoint_id, virtual_cluster_id, region		Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

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
endpoint_id	string	The ID of the managed endpoint.
region	string	AWS region (default: us-east-1)
virtual_cluster_id	string	The ID of the endpoint's virtual cluster.
createdAfter	string (date-time)	The date and time after which the endpoints are created.
createdBefore	string (date-time)	The date and time before which the endpoints are created.
maxResults	integer	The maximum number of managed endpoints that can be listed.
nextToken	string	The token for the next set of managed endpoints to return.
states	array	The states of the managed endpoints.
types	array	The types of the managed endpoints.

SELECT examples

describe_managed_endpoint

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

SELECT
id,
name,
arn,
auth_proxy_url,
certificate_arn,
certificate_authority,
configuration_overrides,
created_at,
execution_role_arn,
failure_reason,
release_label,
security_group,
server_url,
state,
state_details,
subnet_ids,
tags,
type_,
virtual_cluster_id
FROM aws.emr_containers.managed_endpoints
WHERE endpoint_id = '{{ endpoint_id }}' -- required
AND virtual_cluster_id = '{{ virtual_cluster_id }}' -- required
AND region = '{{ region }}' -- required
;

list_managed_endpoints

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

SELECT
id,
name,
arn,
auth_proxy_url,
certificate_arn,
certificate_authority,
configuration_overrides,
created_at,
execution_role_arn,
failure_reason,
release_label,
security_group,
server_url,
state,
state_details,
subnet_ids,
tags,
type_,
virtual_cluster_id
FROM aws.emr_containers.managed_endpoints
WHERE virtual_cluster_id = '{{ virtual_cluster_id }}' -- required
AND region = '{{ region }}' -- required
AND createdBefore = '{{ createdBefore }}'
AND createdAfter = '{{ createdAfter }}'
AND types = '{{ types }}'
AND states = '{{ states }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_managed_endpoint

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

INSERT INTO aws.emr_containers.managed_endpoints (
name,
type,
releaseLabel,
executionRoleArn,
certificateArn,
configurationOverrides,
clientToken,
tags,
sessionIdleTimeoutInMinutes,
virtual_cluster_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ releaseLabel }}' /* required */,
'{{ executionRoleArn }}' /* required */,
'{{ certificateArn }}',
'{{ configurationOverrides }}',
'{{ clientToken }}' /* required */,
'{{ tags }}',
{{ sessionIdleTimeoutInMinutes }},
'{{ virtual_cluster_id }}',
'{{ region }}'
RETURNING
id,
name,
arn,
virtual_cluster_id
;

Manifest

# Description fields are for documentation purposes
- name: managed_endpoints
props:
  - name: virtual_cluster_id
    value: "{{ virtual_cluster_id }}"
    description: Required parameter for the managed_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the managed_endpoints resource.
  - name: name
    value: "{{ name }}"
  - name: type
    value: "{{ type }}"
  - name: releaseLabel
    value: "{{ releaseLabel }}"
  - name: executionRoleArn
    value: "{{ executionRoleArn }}"
  - name: certificateArn
    value: "{{ certificateArn }}"
  - name: configurationOverrides
    description: |
      A configuration specification to be used to override existing configurations.
    value:
      applicationConfiguration:
        - classification: "{{ classification }}"
          properties_: "{{ properties_ }}"
          configurations: "{{ configurations }}"
      monitoringConfiguration:
        managedLogs:
          allowAWSToRetainLogs: "{{ allowAWSToRetainLogs }}"
          encryptionKeyArn: "{{ encryptionKeyArn }}"
        persistentAppUI: "{{ persistentAppUI }}"
        cloudWatchMonitoringConfiguration:
          logGroupName: "{{ logGroupName }}"
          logStreamNamePrefix: "{{ logStreamNamePrefix }}"
        s3MonitoringConfiguration:
          logUri: "{{ logUri }}"
          encryptionKeyArn: "{{ encryptionKeyArn }}"
        containerLogRotationConfiguration:
          rotationSize: "{{ rotationSize }}"
          maxFilesToKeep: {{ maxFilesToKeep }}
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"
  - name: sessionIdleTimeoutInMinutes
    value: {{ sessionIdleTimeoutInMinutes }}

DELETE examples

delete_managed_endpoint

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

DELETE FROM aws.emr_containers.managed_endpoints
WHERE endpoint_id = '{{ endpoint_id }}' --required
AND virtual_cluster_id = '{{ virtual_cluster_id }}' --required
AND region = '{{ region }}' --required
;