Class: Aws::MediaConnect::Types::DestinationEndpoint

Inherits:

Struct

• Object
• Struct
• Aws::MediaConnect::Types::DestinationEndpoint

Defined in:

gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #associated_resource_details ⇒ Types::DestinationEndpointAssociatedResourceDetails

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

• #availability_zone ⇒ String

  The Availability Zone in which the destination endpoint is located.

• #availability_zone_id ⇒ String

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

• #configuration ⇒ Types::DestinationEndpointConfiguration

  The configuration settings for the destination endpoint.

• #connected_source ⇒ String

  The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

• #connection_details ⇒ Types::DestinationEndpointConnectionDetails

  The connection details for the destination endpoint.

• #connection_state ⇒ String

  The connection state of the destination endpoint.

• #created_at ⇒ Time

  The date and time when the destination endpoint was created.

• #decryption_configuration ⇒ Types::EndpointEncryptionConfiguration

  The encryption settings for an endpoint connection.

• #decryption_type ⇒ String

  The type of decryption used for the destination endpoint connection.

• #description ⇒ String

  The description of the destination endpoint.

• #destination_type ⇒ String

  The type of the destination endpoint.

• #id ⇒ String

  The unique identifier of the destination endpoint.

• #lifecycle_management ⇒ String

  The entity that manages the lifecycle of the destination endpoint.

• #messages ⇒ Array<Types::DestinationEndpointMessage>

  The status messages for the destination endpoint.

• #name ⇒ String

  The name of the destination endpoint.

• #region_name ⇒ String

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

• #registration_state ⇒ String

  The registration state of the destination endpoint.

• #resource_share_details ⇒ Types::ResourceShareDetails

  The cross-account sharing details for an endpoint.

• #resource_share_ownership ⇒ String

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

• #tags ⇒ Hash<String,String>

  The tags associated with the destination endpoint.

• #updated_at ⇒ Time

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

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#associated_resource_details ⇒ Types::DestinationEndpointAssociatedResourceDetails

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

Returns:

• (Types::DestinationEndpointAssociatedResourceDetails)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone in which the destination endpoint is located.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

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

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::DestinationEndpointConfiguration

The configuration settings for the destination endpoint.

Returns:

• (Types::DestinationEndpointConfiguration)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connected_source ⇒ String

The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connection_details ⇒ Types::DestinationEndpointConnectionDetails

The connection details for the destination endpoint.

Returns:

• (Types::DestinationEndpointConnectionDetails)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connection_state ⇒ String

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

• CONNECTED – The destination endpoint is connected to a source endpoint.

• DISCONNECTED – The destination endpoint isn't connected to a source endpoint.

• CONNECTING – The destination endpoint is connecting to a source endpoint.

• DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the destination endpoint was created.

Returns:

• (Time)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#decryption_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 2649

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#decryption_type ⇒ String

The type of decryption used for the destination endpoint connection.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destination_type ⇒ String

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

• STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.

• ROUTER_INPUT – A destination endpoint that represents a router input.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_management ⇒ String

The entity that manages the lifecycle of the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#messages ⇒ Array<Types::DestinationEndpointMessage>

The status messages for the destination endpoint.

Returns:

• (Array<Types::DestinationEndpointMessage>)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#region_name ⇒ String

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

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#registration_state ⇒ String

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

• REGISTERED – The destination endpoint is registered and ready to use.

• REGISTERING – MediaConnect is registering the destination endpoint.

• DEREGISTERING – MediaConnect is deregistering the destination endpoint.

• REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_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 2649

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_ownership ⇒ String

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

Returns:

• (String)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

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

class DestinationEndpoint < Struct.new(
  :name,
  :arn,
  :id,
  :description,
  :region_name,
  :availability_zone,
  :availability_zone_id,
  :created_at,
  :updated_at,
  :lifecycle_management,
  :messages,
  :destination_type,
  :configuration,
  :resource_share_ownership,
  :resource_share_details,
  :registration_state,
  :connection_details,
  :connection_state,
  :connected_source,
  :decryption_type,
  :decryption_configuration,
  :associated_resource_details,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end