Class: Aws::MediaConnect::Types::SourceEndpoint

Inherits:

Struct

Object
Struct
Aws::MediaConnect::Types::SourceEndpoint

show all

Defined in:: gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The Amazon Resource Name (ARN) of the source endpoint.
#associated_resource_details ⇒ Types::SourceEndpointAssociatedResourceDetails
The details of the resource that is associated with the source endpoint.
#availability_zone ⇒ String
The Availability Zone in which the source endpoint is located.
#availability_zone_id ⇒ String
The ID of the Availability Zone in which the source endpoint is located.
#configuration ⇒ Types::SourceEndpointConfiguration
The configuration settings for the source endpoint.
#connected_destinations ⇒ Array<String>
The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
#connection_details ⇒ Types::SourceEndpointConnectionDetails
The connection details for the source endpoint.
#connection_state ⇒ String
The connection state of the source endpoint.
#created_at ⇒ Time
The date and time when the source endpoint was created.
#description ⇒ String
The description of the source endpoint.
#encryption_configuration ⇒ Types::EndpointEncryptionConfiguration
The encryption settings for an endpoint connection.
#encryption_type ⇒ String
The type of encryption used for the source endpoint connection.
#id ⇒ String
The unique identifier of the source endpoint.
#lifecycle_management ⇒ String
The entity that manages the lifecycle of the source endpoint.
#messages ⇒ Array<Types::SourceEndpointMessage>
The status messages for the source endpoint.
#name ⇒ String
The name of the source endpoint.
#region_name ⇒ String
The name of the Amazon Web Services Region in which the source endpoint is located.
#registration_state ⇒ String
The registration state of the source endpoint.
#resource_share_details ⇒ Types::ResourceShareDetails
The cross-account sharing details for an endpoint.
#resource_share_ownership ⇒ String
Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
#source_type ⇒ String
The type of the source endpoint.
#tags ⇒ Hash<String,String>
The tags associated with the source endpoint.
#updated_at ⇒ Time
The date and time when the source endpoint was last updated.

Instance Attribute Details

#arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#associated_resource_details ⇒ `Types::SourceEndpointAssociatedResourceDetails`

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

Returns:

(Types::SourceEndpointAssociatedResourceDetails)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ `String`

The Availability Zone in which the source endpoint is located.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ `Types::SourceEndpointConfiguration`

The configuration settings for the source endpoint.

Returns:

(Types::SourceEndpointConfiguration)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connected_destinations ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connection_details ⇒ `Types::SourceEndpointConnectionDetails`

The connection details for the source endpoint.

Returns:

(Types::SourceEndpointConnectionDetails)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connection_state ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time when the source endpoint was created.

Returns:

(Time)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the source endpoint.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ `Types::EndpointEncryptionConfiguration`

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 Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.

Returns:

(Types::EndpointEncryptionConfiguration)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_type ⇒ `String`

The type of encryption used for the source endpoint connection.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

The unique identifier of the source endpoint.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_management ⇒ `String`

The entity that manages the lifecycle of the source endpoint.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#messages ⇒ `Array<Types::SourceEndpointMessage>`

The status messages for the source endpoint.

Returns:

(Array<Types::SourceEndpointMessage>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the source endpoint.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#region_name ⇒ `String`

The name of the Amazon Web Services Region in which the source endpoint is located.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#registration_state ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_details ⇒ `Types::ResourceShareDetails`

The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (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 RAM.

Returns:

(Types::ResourceShareDetails)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_ownership ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_type ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 9694

class SourceEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :source_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_state,
  :connection_details,
  :connected_destinations,
  :encryption_type,
  :encryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::MediaConnect::Types::SourceEndpoint

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#associated_resource_details ⇒ Types::SourceEndpointAssociatedResourceDetails

#availability_zone ⇒ String

#availability_zone_id ⇒ String

#configuration ⇒ Types::SourceEndpointConfiguration

#connected_destinations ⇒ Array<String>

#connection_details ⇒ Types::SourceEndpointConnectionDetails

#connection_state ⇒ String

#created_at ⇒ Time

#description ⇒ String

#encryption_configuration ⇒ Types::EndpointEncryptionConfiguration

#encryption_type ⇒ String

#id ⇒ String

#lifecycle_management ⇒ String

#messages ⇒ Array<Types::SourceEndpointMessage>

#name ⇒ String

#region_name ⇒ String

#registration_state ⇒ String

#resource_share_details ⇒ Types::ResourceShareDetails

#resource_share_ownership ⇒ String

#source_type ⇒ String

#tags ⇒ Hash<String,String>

#updated_at ⇒ Time

#arn ⇒ `String`

#associated_resource_details ⇒ `Types::SourceEndpointAssociatedResourceDetails`

#availability_zone ⇒ `String`

#availability_zone_id ⇒ `String`

#configuration ⇒ `Types::SourceEndpointConfiguration`

#connected_destinations ⇒ `Array<String>`

#connection_details ⇒ `Types::SourceEndpointConnectionDetails`

#connection_state ⇒ `String`

#created_at ⇒ `Time`

#description ⇒ `String`

#encryption_configuration ⇒ `Types::EndpointEncryptionConfiguration`

#encryption_type ⇒ `String`

#id ⇒ `String`

#lifecycle_management ⇒ `String`

#messages ⇒ `Array<Types::SourceEndpointMessage>`

#name ⇒ `String`

#region_name ⇒ `String`

#registration_state ⇒ `String`

#resource_share_details ⇒ `Types::ResourceShareDetails`

#resource_share_ownership ⇒ `String`

#source_type ⇒ `String`

#tags ⇒ `Hash<String,String>`

#updated_at ⇒ `Time`