Package software.amazon.awscdk.services.nimblestudio

Class CfnStreamingImage

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.nimblestudio.CfnStreamingImage
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.496Z") @Stability(Stable) public class CfnStreamingImage extends CfnResource implements IInspectable
A CloudFormation AWS::NimbleStudio::StreamingImage.

The AWS::NimbleStudio::StreamingImage resource creates a streaming image in a studio. A streaming image defines the operating system and software to be used in an streaming session.

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.nimblestudio.*;
 CfnStreamingImage cfnStreamingImage = CfnStreamingImage.Builder.create(this, "MyCfnStreamingImage")
         .ec2ImageId("ec2ImageId")
         .name("name")
         .studioId("studioId")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • 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

    • CfnStreamingImage

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

    • CfnStreamingImage

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

    • CfnStreamingImage

      @Stability(Stable) public CfnStreamingImage(@NotNull Construct scope, @NotNull String id, @NotNull CfnStreamingImageProps props)
      Create a new AWS::NimbleStudio::StreamingImage.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrEncryptionConfigurationKeyArn

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

    • getAttrEncryptionConfigurationKeyType

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

    • getAttrEulaIds

      @Stability(Stable) @NotNull public List<String> getAttrEulaIds()
      The list of IDs of EULAs that must be accepted before a streaming session can be started using this streaming image.

    • getAttrOwner

      @Stability(Stable) @NotNull public String getAttrOwner()
      The owner of the streaming image, either the studioId that contains the streaming image or 'amazon' for images that are provided by .

    • getAttrPlatform

      @Stability(Stable) @NotNull public String getAttrPlatform()
      The platform of the streaming image, either WINDOWS or LINUX.

    • getAttrStreamingImageId

      @Stability(Stable) @NotNull public String getAttrStreamingImageId()
      The unique identifier for the streaming image resource.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getEc2ImageId

      @Stability(Stable) @NotNull public String getEc2ImageId()
      The ID of an EC2 machine image with which to create the streaming image.

    • setEc2ImageId

      @Stability(Stable) public void setEc2ImageId(@NotNull String value)
      The ID of an EC2 machine image with which to create the streaming image.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A friendly name for a streaming image resource.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A friendly name for a streaming image resource.

    • getStudioId

      @Stability(Stable) @NotNull public String getStudioId()
      The unique identifier for a studio resource.

      In Nimble Studio , all other resources are contained in a studio resource.

    • setStudioId

      @Stability(Stable) public void setStudioId(@NotNull String value)
      The unique identifier for a studio resource.

      In Nimble Studio , all other resources are contained in a studio resource.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A human-readable description of the streaming image.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A human-readable description of the streaming image.