software.amazon.awscdk.services.nimblestudio

Class CfnStreamingImage

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.nimblestudio.CfnStreamingImage

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.070Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStreamingImage.Builder A fluent builder for CfnStreamingImage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStreamingImage(software.constructs.Construct scope, String id, CfnStreamingImageProps props) Create a new `AWS::NimbleStudio::StreamingImage`.
protected	CfnStreamingImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStreamingImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAttrEulaIds() The list of IDs of EULAs that must be accepted before a streaming session can be started using this streaming image.
String	getAttrOwner() The owner of the streaming image, either the studioId that contains the streaming image or 'amazon' for images that are provided by .
String	getAttrPlatform() The platform of the streaming image, either WINDOWS or LINUX.
String	getAttrStreamingImageId() The unique identifier for the streaming image resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A human-readable description of the streaming image.
String	getEc2ImageId() The ID of an EC2 machine image with which to create the streaming image.
String	getName() A friendly name for a streaming image resource.
String	getStudioId() The unique identifier for a studio resource.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A human-readable description of the streaming image.
void	setEc2ImageId(String value) The ID of an EC2 machine image with which to create the streaming image.
void	setName(String value) A friendly name for a streaming image resource.
void	setStudioId(String value) The unique identifier for a studio resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStreamingImage

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

CfnStreamingImage

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

CfnStreamingImage

@Stability(value=Stable)
public CfnStreamingImage(@NotNull
                                                  software.constructs.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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEulaIds

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrPlatform()

The platform of the streaming image, either WINDOWS or LINUX.

getAttrStreamingImageId

@Stability(value=Stable)
 @NotNull
public String getAttrStreamingImageId()

The unique identifier for the streaming image resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getEc2ImageId

@Stability(value=Stable)
 @NotNull
public String getEc2ImageId()

The ID of an EC2 machine image with which to create the streaming image.

setEc2ImageId

@Stability(value=Stable)
public void setEc2ImageId(@NotNull
                                                   String value)

The ID of an EC2 machine image with which to create the streaming image.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A friendly name for a streaming image resource.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A friendly name for a streaming image resource.

getStudioId

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getDescription()

A human-readable description of the streaming image.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A human-readable description of the streaming image.