1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. medialive
  5. getCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.medialive.getCluster

Get Started
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::MediaLive::Cluster Resource Type

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:medialive:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The unique ID of the Cluster.
    Id string
    The unique ID of the Cluster.
    id String
    The unique ID of the Cluster.
    id string
    The unique ID of the Cluster.
    id str
    The unique ID of the Cluster.
    id String
    The unique ID of the Cluster.

    getCluster Result

    The following output properties are available:

    Arn string
    The ARN of the Cluster.
    ChannelIds List<string>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    Id string
    The unique ID of the Cluster.
    Name string
    The user-specified name of the Cluster to be created.
    NetworkSettings Pulumi.AwsNative.MediaLive.Outputs.ClusterNetworkSettings
    State Pulumi.AwsNative.MediaLive.ClusterState
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A collection of key-value pairs.
    Arn string
    The ARN of the Cluster.
    ChannelIds []string
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    Id string
    The unique ID of the Cluster.
    Name string
    The user-specified name of the Cluster to be created.
    NetworkSettings ClusterNetworkSettings
    State ClusterStateEnum
    Tags Tag
    A collection of key-value pairs.
    arn String
    The ARN of the Cluster.
    channelIds List<String>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id String
    The unique ID of the Cluster.
    name String
    The user-specified name of the Cluster to be created.
    networkSettings ClusterNetworkSettings
    state ClusterState
    tags List<Tag>
    A collection of key-value pairs.
    arn string
    The ARN of the Cluster.
    channelIds string[]
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id string
    The unique ID of the Cluster.
    name string
    The user-specified name of the Cluster to be created.
    networkSettings ClusterNetworkSettings
    state ClusterState
    tags Tag[]
    A collection of key-value pairs.
    arn str
    The ARN of the Cluster.
    channel_ids Sequence[str]
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id str
    The unique ID of the Cluster.
    name str
    The user-specified name of the Cluster to be created.
    network_settings ClusterNetworkSettings
    state ClusterState
    tags Sequence[root_Tag]
    A collection of key-value pairs.
    arn String
    The ARN of the Cluster.
    channelIds List<String>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id String
    The unique ID of the Cluster.
    name String
    The user-specified name of the Cluster to be created.
    networkSettings Property Map
    state "CREATING" | "CREATE_FAILED" | "ACTIVE" | "DELETING" | "DELETED"
    tags List<Property Map>
    A collection of key-value pairs.

    Supporting Types

    ClusterInterfaceMapping

    LogicalInterfaceName string
    logical interface name, unique in the list
    NetworkId string
    Network Id to be associated with the logical interface name, can be duplicated in list
    LogicalInterfaceName string
    logical interface name, unique in the list
    NetworkId string
    Network Id to be associated with the logical interface name, can be duplicated in list
    logicalInterfaceName String
    logical interface name, unique in the list
    networkId String
    Network Id to be associated with the logical interface name, can be duplicated in list
    logicalInterfaceName string
    logical interface name, unique in the list
    networkId string
    Network Id to be associated with the logical interface name, can be duplicated in list
    logical_interface_name str
    logical interface name, unique in the list
    network_id str
    Network Id to be associated with the logical interface name, can be duplicated in list
    logicalInterfaceName String
    logical interface name, unique in the list
    networkId String
    Network Id to be associated with the logical interface name, can be duplicated in list

    ClusterNetworkSettings

    DefaultRoute string
    Default value if the customer does not define it in channel Output API
    InterfaceMappings List<Pulumi.AwsNative.MediaLive.Inputs.ClusterInterfaceMapping>
    Network mappings for the cluster
    DefaultRoute string
    Default value if the customer does not define it in channel Output API
    InterfaceMappings []ClusterInterfaceMapping
    Network mappings for the cluster
    defaultRoute String
    Default value if the customer does not define it in channel Output API
    interfaceMappings List<ClusterInterfaceMapping>
    Network mappings for the cluster
    defaultRoute string
    Default value if the customer does not define it in channel Output API
    interfaceMappings ClusterInterfaceMapping[]
    Network mappings for the cluster
    default_route str
    Default value if the customer does not define it in channel Output API
    interface_mappings Sequence[ClusterInterfaceMapping]
    Network mappings for the cluster
    defaultRoute String
    Default value if the customer does not define it in channel Output API
    interfaceMappings List<Property Map>
    Network mappings for the cluster

    ClusterState

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate