1. Packages
  2. AWS Native
  3. API Docs
  4. medialive
  5. Cluster

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.medialive.Cluster

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Definition of AWS::MediaLive::Cluster Resource Type

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: Optional[ClusterArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_type: Optional[ClusterType] = None,
                instance_role_arn: Optional[str] = None,
                name: Optional[str] = None,
                network_settings: Optional[ClusterNetworkSettingsArgs] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws-native:medialive:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Cluster resource accepts the following input properties:

    ClusterType Pulumi.AwsNative.MediaLive.ClusterType
    InstanceRoleArn string
    The IAM role your nodes will use.
    Name string
    The user-specified name of the Cluster to be created.
    NetworkSettings Pulumi.AwsNative.MediaLive.Inputs.ClusterNetworkSettings
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A collection of key-value pairs.
    ClusterType ClusterType
    InstanceRoleArn string
    The IAM role your nodes will use.
    Name string
    The user-specified name of the Cluster to be created.
    NetworkSettings ClusterNetworkSettingsArgs
    Tags TagArgs
    A collection of key-value pairs.
    clusterType ClusterType
    instanceRoleArn String
    The IAM role your nodes will use.
    name String
    The user-specified name of the Cluster to be created.
    networkSettings ClusterNetworkSettings
    tags List<Tag>
    A collection of key-value pairs.
    clusterType ClusterType
    instanceRoleArn string
    The IAM role your nodes will use.
    name string
    The user-specified name of the Cluster to be created.
    networkSettings ClusterNetworkSettings
    tags Tag[]
    A collection of key-value pairs.
    cluster_type ClusterType
    instance_role_arn str
    The IAM role your nodes will use.
    name str
    The user-specified name of the Cluster to be created.
    network_settings ClusterNetworkSettingsArgs
    tags Sequence[TagArgs]
    A collection of key-value pairs.
    clusterType "ON_PREMISES" | "OUTPOSTS_RACK" | "OUTPOSTS_SERVER" | "EC2"
    instanceRoleArn String
    The IAM role your nodes will use.
    name String
    The user-specified name of the Cluster to be created.
    networkSettings Property Map
    tags List<Property Map>
    A collection of key-value pairs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string
    The ARN of the Cluster.
    AwsId string
    The unique ID of the Cluster.
    ChannelIds List<string>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    State Pulumi.AwsNative.MediaLive.ClusterState
    Arn string
    The ARN of the Cluster.
    AwsId string
    The unique ID of the Cluster.
    ChannelIds []string
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    State ClusterStateEnum
    arn String
    The ARN of the Cluster.
    awsId String
    The unique ID of the Cluster.
    channelIds List<String>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    state ClusterState
    arn string
    The ARN of the Cluster.
    awsId string
    The unique ID of the Cluster.
    channelIds string[]
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    state ClusterState
    arn str
    The ARN of the Cluster.
    aws_id str
    The unique ID of the Cluster.
    channel_ids Sequence[str]
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    state ClusterState
    arn String
    The ARN of the Cluster.
    awsId String
    The unique ID of the Cluster.
    channelIds List<String>
    The MediaLive Channels that are currently running on Nodes in this Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    state "CREATING" | "CREATE_FAILED" | "ACTIVE" | "DELETING" | "DELETED"

    Supporting Types

    ClusterInterfaceMapping, ClusterInterfaceMappingArgs

    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, ClusterNetworkSettingsArgs

    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, ClusterStateArgs

    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    ClusterStateCreating
    CREATING
    ClusterStateCreateFailed
    CREATE_FAILED
    ClusterStateActive
    ACTIVE
    ClusterStateDeleting
    DELETING
    ClusterStateDeleted
    DELETED
    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    CREATING
    CREATING
    CREATE_FAILED
    CREATE_FAILED
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    DELETED
    DELETED
    "CREATING"
    CREATING
    "CREATE_FAILED"
    CREATE_FAILED
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "DELETED"
    DELETED

    ClusterType, ClusterTypeArgs

    OnPremises
    ON_PREMISES
    OutpostsRack
    OUTPOSTS_RACK
    OutpostsServer
    OUTPOSTS_SERVER
    Ec2
    EC2
    ClusterTypeOnPremises
    ON_PREMISES
    ClusterTypeOutpostsRack
    OUTPOSTS_RACK
    ClusterTypeOutpostsServer
    OUTPOSTS_SERVER
    ClusterTypeEc2
    EC2
    OnPremises
    ON_PREMISES
    OutpostsRack
    OUTPOSTS_RACK
    OutpostsServer
    OUTPOSTS_SERVER
    Ec2
    EC2
    OnPremises
    ON_PREMISES
    OutpostsRack
    OUTPOSTS_RACK
    OutpostsServer
    OUTPOSTS_SERVER
    Ec2
    EC2
    ON_PREMISES
    ON_PREMISES
    OUTPOSTS_RACK
    OUTPOSTS_RACK
    OUTPOSTS_SERVER
    OUTPOSTS_SERVER
    EC2
    EC2
    "ON_PREMISES"
    ON_PREMISES
    "OUTPOSTS_RACK"
    OUTPOSTS_RACK
    "OUTPOSTS_SERVER"
    OUTPOSTS_SERVER
    "EC2"
    EC2

    Tag, TagArgs

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi