SourceEndpoint

The details of a source endpoint in MediaConnect, including its configuration, state, and connection details.

arn

The Amazon Resource Name (ARN) of the source endpoint.

Type: String

Length Constraints: Minimum length of 64. Maximum length of 128.

Pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:sourceEndpoint:[a-z0-9]{12}

Required: Yes

associatedResourceDetails

The details of the resource that is associated with the source endpoint.

Type: SourceEndpointAssociatedResourceDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

configuration

The configuration settings for the source endpoint.

Type: SourceEndpointConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

connectedDestinations

The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.

Type: Array of strings

Length Constraints: Minimum length of 64. Maximum length of 128.

Pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:destinationEndpoint:[a-z0-9]{12}

Required: Yes

connectionState

The connection state of the source endpoint. Valid values include the following:

CONNECTED – The source endpoint is connected to a destination endpoint.
DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
CONNECTING – The source endpoint is connecting to a destination endpoint.
DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

Type: String

Valid Values: CONNECTED | DISCONNECTED | CONNECTING | DISCONNECTING

Required: Yes

createdAt

The date and time when the source endpoint was created.

Type: Timestamp

Required: Yes

description

The description of the source endpoint.

Type: String

Required: Yes

id

The unique identifier of the source endpoint.

Type: String

Required: Yes

lifecycleManagement

The entity that manages the lifecycle of the source endpoint.

Type: String

Valid Values: MANAGED | UNMANAGED

Required: Yes

messages

The status messages for the source endpoint.

Type: Array of SourceEndpointMessage objects

Required: Yes

name

The name of the source endpoint.

Type: String

Required: Yes

regionName

The name of the AWS Region in which the source endpoint is located.

Type: String

Required: Yes

registrationState

The registration state of the source endpoint. Valid values include the following:

REGISTERED – The source endpoint is registered and ready to use.
REGISTERING – MediaConnect is registering the source endpoint.
DEREGISTERING – MediaConnect is deregistering the source endpoint.
REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.

Type: String

Valid Values: REGISTERED | REGISTERING | DEREGISTERING | REGISTRATION_FAILED

Required: Yes

resourceShareDetails

The cross-account sharing details for an endpoint. Endpoints are shared through AWS Resource Access Manager (AWS RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use AWS RAM.

Type: ResourceShareDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

resourceShareOwnership

Indicates whether this account owns the source endpoint or consumes it from another account through AWS RAM.

Type: String

Valid Values: OWNED | CONSUMED

Required: Yes

sourceType

The type of the source endpoint. Valid values include the following:

STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
ROUTER_OUTPUT – A source endpoint that represents a router output.

Type: String

Valid Values: STANDARD | ROUTER_OUTPUT

Required: Yes

tags

The tags associated with the source endpoint. Each tag is a key-value pair.

Type: String to string map

Required: Yes

updatedAt

The date and time when the source endpoint was last updated.

Type: Timestamp

Required: Yes

availabilityZone

The Availability Zone in which the source endpoint is located.

Type: String

Required: No

availabilityZoneId

The ID of the Availability Zone in which the source endpoint is located.

Type: String

Required: No

connectionDetails

The connection details for the source endpoint.

Type: SourceEndpointConnectionDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

encryptionConfiguration

The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in AWS Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.

Type: EndpointEncryptionConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

encryptionType

The type of encryption used for the source endpoint connection.

Type: String

Valid Values: SECRETS_MANAGER | AUTOMATIC

Required: No

SourceEndpoint

Contents

See Also