Skip to content

Endpoint

Source code in docs_src/capo_emr_containers/types/endpoint.py
class Endpoint(TypedDict, closed=True):
    id: NotRequired["capo_emr_containers.types.resource_id_string.ResourceIdString"]
    """<p>The ID of the endpoint.</p>"""
    name: NotRequired[
        "capo_emr_containers.types.resource_name_string.ResourceNameString"
    ]
    """<p>The name of the endpoint.</p>"""
    arn: NotRequired["capo_emr_containers.types.endpoint_arn.EndpointArn"]
    """<p>The ARN of the endpoint.</p>"""
    virtual_cluster_id: NotRequired[
        "capo_emr_containers.types.resource_id_string.ResourceIdString"
    ]
    """<p>The ID of the endpoint's virtual cluster.</p>"""
    type: NotRequired["capo_emr_containers.types.endpoint_type.EndpointType"]
    """<p>The type of the endpoint.</p>"""
    state: NotRequired["capo_emr_containers.types.endpoint_state.EndpointState"]
    """<p>The state of the endpoint.</p>"""
    release_label: NotRequired["capo_emr_containers.types.release_label.ReleaseLabel"]
    """<p>The EMR release version to be used for the endpoint.</p>"""
    execution_role_arn: NotRequired["capo_emr_containers.types.iam_role_arn.IAMRoleArn"]
    """<p>The execution role ARN of the endpoint.</p>"""
    certificate_arn: NotRequired["capo_emr_containers.types.acm_cert_arn.ACMCertArn"]
    """<p>The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.</p>"""
    certificate_authority: NotRequired[
        "capo_emr_containers.types.certificate.Certificate"
    ]
    """<p>The certificate generated by emr control plane on customer behalf to secure the managed endpoint.</p>"""
    configuration_overrides: NotRequired[
        "capo_emr_containers.types.configuration_overrides.ConfigurationOverrides"
    ]
    """<p>The configuration settings that are used to override existing configurations for endpoints.</p>"""
    server_url: NotRequired["capo_emr_containers.types.uri_string.UriString"]
    """<p>The server URL of the endpoint.</p>"""
    auth_proxy_url: NotRequired["capo_emr_containers.types.uri_string.UriString"]
    """<p>The authentication proxy URL of the endpoint.</p>"""
    created_at: NotRequired["capo_emr_containers.types.date.Date"]
    """<p>The date and time when the endpoint was created.</p>"""
    security_group: NotRequired["capo_emr_containers.types.string256.String256"]
    """<p>The security group configuration of the endpoint. </p>"""
    subnet_ids: NotRequired["capo_emr_containers.types.subnet_ids.SubnetIds"]
    """<p>The subnet IDs of the endpoint. </p>"""
    state_details: NotRequired["capo_emr_containers.types.string256.String256"]
    """<p> Additional details of the endpoint state. </p>"""
    failure_reason: NotRequired[
        "capo_emr_containers.types.failure_reason.FailureReason"
    ]
    """<p> The reasons why the endpoint has failed. </p>"""
    tags: NotRequired["capo_emr_containers.types.tag_map.TagMap"]
    """<p>The tags of the endpoint. </p>"""

arn instance-attribute

arn: NotRequired[EndpointArn]

The ARN of the endpoint.

auth_proxy_url instance-attribute

auth_proxy_url: NotRequired[UriString]

The authentication proxy URL of the endpoint.

certificate_arn instance-attribute

certificate_arn: NotRequired[ACMCertArn]

The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

certificate_authority instance-attribute

certificate_authority: NotRequired[Certificate]

The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

configuration_overrides instance-attribute

configuration_overrides: NotRequired[ConfigurationOverrides]

The configuration settings that are used to override existing configurations for endpoints.

created_at instance-attribute

created_at: NotRequired[Date]

The date and time when the endpoint was created.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[IAMRoleArn]

The execution role ARN of the endpoint.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The reasons why the endpoint has failed.

id instance-attribute

id: NotRequired[ResourceIdString]

The ID of the endpoint.

name instance-attribute

name: NotRequired[ResourceNameString]

The name of the endpoint.

release_label instance-attribute

release_label: NotRequired[ReleaseLabel]

The EMR release version to be used for the endpoint.

security_group instance-attribute

security_group: NotRequired[String256]

The security group configuration of the endpoint.

server_url instance-attribute

server_url: NotRequired[UriString]

The server URL of the endpoint.

state instance-attribute

state: NotRequired[EndpointState]

The state of the endpoint.

state_details instance-attribute

state_details: NotRequired[String256]

Additional details of the endpoint state.

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIds]

The subnet IDs of the endpoint.

tags instance-attribute

tags: NotRequired[TagMap]

The tags of the endpoint.

type instance-attribute

type: NotRequired[EndpointType]

The type of the endpoint.

virtual_cluster_id instance-attribute

virtual_cluster_id: NotRequired[ResourceIdString]

The ID of the endpoint's virtual cluster.