Skip to content
v2.274.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ClusterProps Struct ​

Properties for creating a MediaLive Cluster.

Example ​

ts
declare const stack: Stack;
declare const instanceRole: iam.IRole;

const cluster = new medialive.Cluster(stack, 'Cluster', {
  clusterName: 'on-prem-cluster',
  clusterType: medialive.ClusterType.ON_PREMISES,
  instanceRole,
});

Properties ​

clusterNameoptionalstringcluster_nameoptionalstrclusterNameoptionalStringClusterNameoptionalstringClusterNameoptional*string#
The name of the cluster.

Default: auto-generated name

clusterTypeoptionalClusterTypecluster_typeoptionalClusterTypeclusterTypeoptionalClusterTypeClusterTypeoptionalClusterTypeClusterTypeoptionalClusterType= ClusterType.ON_PREMISES#
The hardware type for the cluster.
instanceRoleIRoleinstance_roleIRoleinstanceRoleIRoleInstanceRoleIRoleInstanceRoleIRolerequired#
The IAM role for nodes in the cluster.

[disable-awslint:prefer-ref-interface]

networkSettingsoptionalClusterNetworkSettingsnetwork_settingsoptionalClusterNetworkSettingsnetworkSettingsoptionalClusterNetworkSettingsNetworkSettingsoptionalClusterNetworkSettingsNetworkSettingsoptionalClusterNetworkSettings#
Network settings for the cluster - only required if your networking setup requires it.

Default: no network settings

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Tags to add to the cluster.

Default: no tags