Package software.amazon.awscdk.services.medialive

Class CfnNetwork

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.medialive.CfnNetwork
All Implemented Interfaces:
IInspectable, ITaggableV2, INetworkRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:42.197Z") @Stability(Stable) public class CfnNetwork extends CfnResource implements IInspectable, INetworkRef, ITaggableV2
Resource schema for AWS::MediaLive::Network.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 CfnNetwork cfnNetwork = CfnNetwork.Builder.create(this, "MyCfnNetwork")
         .ipPools(List.of(IpPoolProperty.builder()
                 .cidr("cidr")
                 .build()))
         .name("name")
         // the properties below are optional
         .routes(List.of(RouteProperty.builder()
                 .cidr("cidr")
                 .gateway("gateway")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNetwork

      protected CfnNetwork(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNetwork

      protected CfnNetwork(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNetwork

      @Stability(Stable) public CfnNetwork(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNetworkProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromNetworkArn

      @Stability(Stable) @NotNull public static INetworkRef fromNetworkArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new INetworkRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromNetworkId

      @Stability(Stable) @NotNull public static INetworkRef fromNetworkId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String networkId)
      Creates a new INetworkRef from a networkId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      networkId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the Network.

    • getAttrAssociatedClusterIds

      @Stability(Stable) @NotNull public List<String> getAttrAssociatedClusterIds()

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique ID of the Network.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNetworkRef

      @Stability(Stable) @NotNull public NetworkReference getNetworkRef()
      A reference to a Network resource.
      Specified by:
      getNetworkRef in interface INetworkRef

    • getIpPools

      @Stability(Stable) @NotNull public Object getIpPools()
      The list of IP address cidr pools for the network.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetwork.IpPoolProperty>

    • setIpPools

      @Stability(Stable) public void setIpPools(@NotNull IResolvable value)
      The list of IP address cidr pools for the network.

    • setIpPools

      @Stability(Stable) public void setIpPools(@NotNull List<Object> value)
      The list of IP address cidr pools for the network.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The user-specified name of the Network to be created.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The user-specified name of the Network to be created.

    • getRoutes

      @Stability(Stable) @Nullable public Object getRoutes()
      The routes for the network.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetwork.RouteProperty>

    • setRoutes

      @Stability(Stable) public void setRoutes(@Nullable IResolvable value)
      The routes for the network.

    • setRoutes

      @Stability(Stable) public void setRoutes(@Nullable List<Object> value)
      The routes for the network.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A collection of key-value pairs.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A collection of key-value pairs.