AWS CDK Reference

Appearance

v2.276.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.

Stability
Experimental
Source
lib/cluster.ts

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,
});
python
# stack: Stack
# instance_role: iam.IRole


cluster = medialive.Cluster(stack, "Cluster",
    cluster_name="on-prem-cluster",
    cluster_type=medialive.ClusterType.ON_PREMISES,
    instance_role=instance_role
)
java
Stack stack;
IRole instanceRole;


Cluster cluster = Cluster.Builder.create(stack, "Cluster")
        .clusterName("on-prem-cluster")
        .clusterType(ClusterType.ON_PREMISES)
        .instanceRole(instanceRole)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
Stack stack;
IRole instanceRole;


var cluster = new Cluster(stack, "Cluster", new ClusterProps {
    ClusterName = "on-prem-cluster",
    ClusterType = ClusterType.ON_PREMISES,
    InstanceRole = instanceRole
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
var stack Stack
var instanceRole IRole


cluster := medialive.NewCluster(stack, jsii.String("Cluster"), &ClusterProps{
	ClusterName: jsii.String("on-prem-cluster"),
	ClusterType: medialive.ClusterType_ON_PREMISES(),
	InstanceRole: 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