MediaLive / Client / update_cluster

update_cluster#

MediaLive.Client.update_cluster(**kwargs)#

Change the settings for a Cluster.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster(
    ClusterId='string',
    Name='string',
    NetworkSettings={
        'DefaultRoute': 'string',
        'InterfaceMappings': [
            {
                'LogicalInterfaceName': 'string',
                'NetworkId': 'string'
            },
        ]
    }
)
Parameters:

  • ClusterId (string) – [REQUIRED] The ID of the cluster

  • Name (string) – Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can’t change the name. Names are case-sensitive.

  • NetworkSettings (dict) –

    Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with.

    • DefaultRoute (string) – Include this parameter only if you want to change the default route for the Cluster. Specify one network interface as the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn’t covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings.

    • InterfaceMappings (list) – An array of interfaceMapping objects for this Cluster. Include this parameter only if you want to change the interface mappings for the Cluster. Typically, you change the interface mappings only to fix an error you made when creating the mapping. In an update request, make sure that you enter the entire set of mappings again, not just the mappings that you want to add or change. You define this mapping so that the mapping can be used by all the Nodes. Each mapping logically connects one interface on the nodes with one Network. Each mapping consists of a pair of parameters. The logicalInterfaceName parameter creates a logical name for the Node interface that handles a specific type of traffic. For example, my-Inputs-Interface. The networkID parameter refers to the ID of the network. When you create the Nodes in this Cluster, you will associate the logicalInterfaceName with the appropriate physical interface.

      • (dict) – Placeholder documentation for InterfaceMappingUpdateRequest

        • LogicalInterfaceName (string) – The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface.

        • NetworkId (string) – The ID of the network that you want to connect to the specified logicalInterfaceName. You can use the ListNetworks operation to discover all the IDs.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ChannelIds': [
        'string',
    ],
    'ClusterType': 'ON_PREMISES',
    'Id': 'string',
    'Name': 'string',
    'NetworkSettings': {
        'DefaultRoute': 'string',
        'InterfaceMappings': [
            {
                'LogicalInterfaceName': 'string',
                'NetworkId': 'string'
            },
        ]
    },
    'State': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETE_FAILED'|'DELETED'
}

Response Structure

  • (dict) – The cluster has been successfully updated.

    • Arn (string) – The ARN of the Cluster.

    • ChannelIds (list) – An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.

      • (string) – Placeholder documentation for __string

    • ClusterType (string) – The hardware type for the Cluster

    • Id (string) – The unique ID of the Cluster.

    • Name (string) – The user-specified name of the Cluster.

    • NetworkSettings (dict) – Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.

      • DefaultRoute (string) – The network interface that is the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn’t covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings.

      • InterfaceMappings (list) – An array of interfaceMapping objects for this Cluster. Each mapping logically connects one interface on the nodes with one Network. You need only one mapping for each interface because all the Nodes share the mapping.

        • (dict) – Used in ClusterNetworkSettings

          • LogicalInterfaceName (string) – The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface.

          • NetworkId (string) – The ID of the network that you want to connect to the specified logicalInterfaceName.

    • State (string) – The current state of the Cluster.

Exceptions