We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- Cluster
Type Pulumi.Aws Native. Media Live. Cluster Type - Instance
Role stringArn - The IAM role your nodes will use.
- Name string
- The user-specified name of the Cluster to be created.
- Network
Settings Pulumi.Aws Native. Media Live. Inputs. Cluster Network Settings -
List<Pulumi.
Aws Native. Inputs. Tag> - A collection of key-value pairs.
- Cluster
Type ClusterType - Instance
Role stringArn - The IAM role your nodes will use.
- Name string
- The user-specified name of the Cluster to be created.
- Network
Settings ClusterNetwork Settings Args -
Tag
Args - A collection of key-value pairs.
- cluster
Type ClusterType - instance
Role StringArn - The IAM role your nodes will use.
- name String
- The user-specified name of the Cluster to be created.
- network
Settings ClusterNetwork Settings - List<Tag>
- A collection of key-value pairs.
- cluster
Type ClusterType - instance
Role stringArn - The IAM role your nodes will use.
- name string
- The user-specified name of the Cluster to be created.
- network
Settings ClusterNetwork Settings - Tag[]
- A collection of key-value pairs.
- cluster_
type ClusterType - instance_
role_ strarn - The IAM role your nodes will use.
- name str
- The user-specified name of the Cluster to be created.
- network_
settings ClusterNetwork Settings Args -
Sequence[Tag
Args] - A collection of key-value pairs.
- cluster
Type "ON_PREMISES" | "OUTPOSTS_RACK" | "OUTPOSTS_SERVER" | "EC2" - instance
Role StringArn - The IAM role your nodes will use.
- name String
- The user-specified name of the Cluster to be created.
- network
Settings Property Map - 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.
- Aws
Id string - The unique ID of the Cluster.
- Channel
Ids 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.
Aws Native. Media Live. Cluster State
- Arn string
- The ARN of the Cluster.
- Aws
Id string - The unique ID of the Cluster.
- Channel
Ids []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
Cluster
State Enum
- arn String
- The ARN of the Cluster.
- aws
Id String - The unique ID of the Cluster.
- channel
Ids 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
Cluster
State
- arn string
- The ARN of the Cluster.
- aws
Id string - The unique ID of the Cluster.
- channel
Ids 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
Cluster
State
- 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
Cluster
State
- arn String
- The ARN of the Cluster.
- aws
Id String - The unique ID of the Cluster.
- channel
Ids 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
Network mappings for the cluster- Logical
Interface stringName - logical interface name, unique in the list
- Network
Id string - Network Id to be associated with the logical interface name, can be duplicated in list
- Logical
Interface stringName - logical interface name, unique in the list
- Network
Id string - Network Id to be associated with the logical interface name, can be duplicated in list
- logical
Interface StringName - logical interface name, unique in the list
- network
Id String - Network Id to be associated with the logical interface name, can be duplicated in list
- logical
Interface stringName - logical interface name, unique in the list
- network
Id string - Network Id to be associated with the logical interface name, can be duplicated in list
- logical_
interface_ strname - 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
- logical
Interface StringName - logical interface name, unique in the list
- network
Id String - Network Id to be associated with the logical interface name, can be duplicated in list
ClusterNetworkSettings, ClusterNetworkSettingsArgs
On premises settings which will have the interface network mappings and default Output logical interface- Default
Route string - Default value if the customer does not define it in channel Output API
- Interface
Mappings List<Pulumi.Aws Native. Media Live. Inputs. Cluster Interface Mapping> - Network mappings for the cluster
- Default
Route string - Default value if the customer does not define it in channel Output API
- Interface
Mappings []ClusterInterface Mapping - Network mappings for the cluster
- default
Route String - Default value if the customer does not define it in channel Output API
- interface
Mappings List<ClusterInterface Mapping> - Network mappings for the cluster
- default
Route string - Default value if the customer does not define it in channel Output API
- interface
Mappings ClusterInterface Mapping[] - Network mappings for the cluster
- default_
route str - Default value if the customer does not define it in channel Output API
- interface_
mappings Sequence[ClusterInterface Mapping] - Network mappings for the cluster
- default
Route String - Default value if the customer does not define it in channel Output API
- interface
Mappings List<Property Map> - Network mappings for the cluster
ClusterState, ClusterStateArgs
- Creating
CREATING- Create
Failed CREATE_FAILED- Active
ACTIVE- Deleting
DELETING- Deleted
DELETED
- Cluster
State Creating CREATING- Cluster
State Create Failed CREATE_FAILED- Cluster
State Active ACTIVE- Cluster
State Deleting DELETING- Cluster
State 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
- 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
- On
Premises ON_PREMISES- Outposts
Rack OUTPOSTS_RACK- Outposts
Server OUTPOSTS_SERVER- Ec2
EC2
- Cluster
Type On Premises ON_PREMISES- Cluster
Type Outposts Rack OUTPOSTS_RACK- Cluster
Type Outposts Server OUTPOSTS_SERVER- Cluster
Type 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
- 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
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
