Documentation ¶
Index ¶
- func CfnLaunchProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunchProfile_IsCfnElement(x interface{}) *bool
- func CfnLaunchProfile_IsCfnResource(x interface{}) *bool
- func CfnLaunchProfile_IsConstruct(x interface{}) *bool
- func CfnStreamingImage_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStreamingImage_IsCfnElement(x interface{}) *bool
- func CfnStreamingImage_IsCfnResource(x interface{}) *bool
- func CfnStreamingImage_IsConstruct(x interface{}) *bool
- func CfnStudioComponent_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStudioComponent_IsCfnElement(x interface{}) *bool
- func CfnStudioComponent_IsCfnResource(x interface{}) *bool
- func CfnStudioComponent_IsConstruct(x interface{}) *bool
- func CfnStudio_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStudio_IsCfnElement(x interface{}) *bool
- func CfnStudio_IsCfnResource(x interface{}) *bool
- func CfnStudio_IsConstruct(x interface{}) *bool
- func NewCfnLaunchProfile_Override(c CfnLaunchProfile, scope constructs.Construct, id *string, ...)
- func NewCfnStreamingImage_Override(c CfnStreamingImage, scope constructs.Construct, id *string, ...)
- func NewCfnStudioComponent_Override(c CfnStudioComponent, scope constructs.Construct, id *string, ...)
- func NewCfnStudio_Override(c CfnStudio, scope constructs.Construct, id *string, props *CfnStudioProps)
- type CfnLaunchProfile
- type CfnLaunchProfileProps
- type CfnLaunchProfile_StreamConfigurationProperty
- type CfnLaunchProfile_StreamConfigurationSessionBackupProperty
- type CfnLaunchProfile_StreamConfigurationSessionStorageProperty
- type CfnLaunchProfile_StreamingSessionStorageRootProperty
- type CfnLaunchProfile_VolumeConfigurationProperty
- type CfnStreamingImage
- type CfnStreamingImageProps
- type CfnStreamingImage_StreamingImageEncryptionConfigurationProperty
- type CfnStudio
- type CfnStudioComponent
- type CfnStudioComponentProps
- type CfnStudioComponent_ActiveDirectoryComputerAttributeProperty
- type CfnStudioComponent_ActiveDirectoryConfigurationProperty
- type CfnStudioComponent_ComputeFarmConfigurationProperty
- type CfnStudioComponent_LicenseServiceConfigurationProperty
- type CfnStudioComponent_ScriptParameterKeyValueProperty
- type CfnStudioComponent_SharedFileSystemConfigurationProperty
- type CfnStudioComponent_StudioComponentConfigurationProperty
- type CfnStudioComponent_StudioComponentInitializationScriptProperty
- type CfnStudioProps
- type CfnStudio_StudioEncryptionConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnLaunchProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnLaunchProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnLaunchProfile_IsCfnElement ¶
func CfnLaunchProfile_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLaunchProfile_IsCfnResource ¶
func CfnLaunchProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLaunchProfile_IsConstruct ¶
func CfnLaunchProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStreamingImage_CFN_RESOURCE_TYPE_NAME ¶
func CfnStreamingImage_CFN_RESOURCE_TYPE_NAME() *string
func CfnStreamingImage_IsCfnElement ¶
func CfnStreamingImage_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStreamingImage_IsCfnResource ¶
func CfnStreamingImage_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStreamingImage_IsConstruct ¶
func CfnStreamingImage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStudioComponent_CFN_RESOURCE_TYPE_NAME ¶
func CfnStudioComponent_CFN_RESOURCE_TYPE_NAME() *string
func CfnStudioComponent_IsCfnElement ¶
func CfnStudioComponent_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStudioComponent_IsCfnResource ¶
func CfnStudioComponent_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStudioComponent_IsConstruct ¶
func CfnStudioComponent_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStudio_CFN_RESOURCE_TYPE_NAME ¶
func CfnStudio_CFN_RESOURCE_TYPE_NAME() *string
func CfnStudio_IsCfnElement ¶
func CfnStudio_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStudio_IsCfnResource ¶
func CfnStudio_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStudio_IsConstruct ¶
func CfnStudio_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnLaunchProfile_Override ¶
func NewCfnLaunchProfile_Override(c CfnLaunchProfile, scope constructs.Construct, id *string, props *CfnLaunchProfileProps)
func NewCfnStreamingImage_Override ¶
func NewCfnStreamingImage_Override(c CfnStreamingImage, scope constructs.Construct, id *string, props *CfnStreamingImageProps)
func NewCfnStudioComponent_Override ¶
func NewCfnStudioComponent_Override(c CfnStudioComponent, scope constructs.Construct, id *string, props *CfnStudioComponentProps)
func NewCfnStudio_Override ¶
func NewCfnStudio_Override(c CfnStudio, scope constructs.Construct, id *string, props *CfnStudioProps)
Types ¶
type CfnLaunchProfile ¶
type CfnLaunchProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The unique identifier for the launch profile resource. AttrLaunchProfileId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A human-readable description of the launch profile. Description() *string SetDescription(val *string) // Unique identifiers for a collection of EC2 subnets. Ec2SubnetIds() *[]*string SetEc2SubnetIds(val *[]*string) // The version number of the protocol that is used by the launch profile. LaunchProfileProtocolVersions() *[]*string SetLaunchProfileProtocolVersions(val *[]*string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A friendly name for the launch profile. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A configuration for a streaming session. StreamConfiguration() interface{} SetStreamConfiguration(val interface{}) // Unique identifiers for a collection of studio components that can be used with this launch profile. StudioComponentIds() *[]*string SetStudioComponentIds(val *[]*string) // The unique identifier for a studio resource. StudioId() *string SetStudioId(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::NimbleStudio::LaunchProfile` resource represents access permissions for a set of studio components, including types of workstations, render farms, and shared file systems.
Launch profiles are shared with studio users to give them access to the set of studio components.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLaunchProfile := awscdk.Aws_nimblestudio.NewCfnLaunchProfile(this, jsii.String("MyCfnLaunchProfile"), &CfnLaunchProfileProps{ Ec2SubnetIds: []*string{ jsii.String("ec2SubnetIds"), }, LaunchProfileProtocolVersions: []*string{ jsii.String("launchProfileProtocolVersions"), }, Name: jsii.String("name"), StreamConfiguration: &StreamConfigurationProperty{ ClipboardMode: jsii.String("clipboardMode"), Ec2InstanceTypes: []*string{ jsii.String("ec2InstanceTypes"), }, StreamingImageIds: []*string{ jsii.String("streamingImageIds"), }, // the properties below are optional AutomaticTerminationMode: jsii.String("automaticTerminationMode"), MaxSessionLengthInMinutes: jsii.Number(123), MaxStoppedSessionLengthInMinutes: jsii.Number(123), SessionBackup: &StreamConfigurationSessionBackupProperty{ MaxBackupsToRetain: jsii.Number(123), Mode: jsii.String("mode"), }, SessionPersistenceMode: jsii.String("sessionPersistenceMode"), SessionStorage: &StreamConfigurationSessionStorageProperty{ Mode: []*string{ jsii.String("mode"), }, // the properties below are optional Root: &StreamingSessionStorageRootProperty{ Linux: jsii.String("linux"), Windows: jsii.String("windows"), }, }, VolumeConfiguration: &VolumeConfigurationProperty{ Iops: jsii.Number(123), Size: jsii.Number(123), Throughput: jsii.Number(123), }, }, StudioComponentIds: []*string{ jsii.String("studioComponentIds"), }, StudioId: jsii.String("studioId"), // the properties below are optional Description: jsii.String("description"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnLaunchProfile ¶
func NewCfnLaunchProfile(scope constructs.Construct, id *string, props *CfnLaunchProfileProps) CfnLaunchProfile
type CfnLaunchProfileProps ¶
type CfnLaunchProfileProps struct { // Unique identifiers for a collection of EC2 subnets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-ec2subnetids // Ec2SubnetIds *[]*string `field:"required" json:"ec2SubnetIds" yaml:"ec2SubnetIds"` // The version number of the protocol that is used by the launch profile. // // The only valid version is "2021-03-31". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-launchprofileprotocolversions // LaunchProfileProtocolVersions *[]*string `field:"required" json:"launchProfileProtocolVersions" yaml:"launchProfileProtocolVersions"` // A friendly name for the launch profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-name // Name *string `field:"required" json:"name" yaml:"name"` // A configuration for a streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-streamconfiguration // StreamConfiguration interface{} `field:"required" json:"streamConfiguration" yaml:"streamConfiguration"` // Unique identifiers for a collection of studio components that can be used with this launch profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-studiocomponentids // StudioComponentIds *[]*string `field:"required" json:"studioComponentIds" yaml:"studioComponentIds"` // The unique identifier for a studio resource. // // In Nimble Studio, all other resources are contained in a studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-studioid // StudioId *string `field:"required" json:"studioId" yaml:"studioId"` // A human-readable description of the launch profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-description // Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnLaunchProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLaunchProfileProps := &CfnLaunchProfileProps{ Ec2SubnetIds: []*string{ jsii.String("ec2SubnetIds"), }, LaunchProfileProtocolVersions: []*string{ jsii.String("launchProfileProtocolVersions"), }, Name: jsii.String("name"), StreamConfiguration: &StreamConfigurationProperty{ ClipboardMode: jsii.String("clipboardMode"), Ec2InstanceTypes: []*string{ jsii.String("ec2InstanceTypes"), }, StreamingImageIds: []*string{ jsii.String("streamingImageIds"), }, // the properties below are optional AutomaticTerminationMode: jsii.String("automaticTerminationMode"), MaxSessionLengthInMinutes: jsii.Number(123), MaxStoppedSessionLengthInMinutes: jsii.Number(123), SessionBackup: &StreamConfigurationSessionBackupProperty{ MaxBackupsToRetain: jsii.Number(123), Mode: jsii.String("mode"), }, SessionPersistenceMode: jsii.String("sessionPersistenceMode"), SessionStorage: &StreamConfigurationSessionStorageProperty{ Mode: []*string{ jsii.String("mode"), }, // the properties below are optional Root: &StreamingSessionStorageRootProperty{ Linux: jsii.String("linux"), Windows: jsii.String("windows"), }, }, VolumeConfiguration: &VolumeConfigurationProperty{ Iops: jsii.Number(123), Size: jsii.Number(123), Throughput: jsii.Number(123), }, }, StudioComponentIds: []*string{ jsii.String("studioComponentIds"), }, StudioId: jsii.String("studioId"), // the properties below are optional Description: jsii.String("description"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnLaunchProfile_StreamConfigurationProperty ¶
type CfnLaunchProfile_StreamConfigurationProperty struct { // Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-clipboardmode // ClipboardMode *string `field:"required" json:"clipboardMode" yaml:"clipboardMode"` // The EC2 instance types that users can select from when launching a streaming session with this launch profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-ec2instancetypes // Ec2InstanceTypes *[]*string `field:"required" json:"ec2InstanceTypes" yaml:"ec2InstanceTypes"` // The streaming images that users can select from when launching a streaming session with this launch profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-streamingimageids // StreamingImageIds *[]*string `field:"required" json:"streamingImageIds" yaml:"streamingImageIds"` // Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state. // // - When `ACTIVATED` , the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes` . // - When `DEACTIVATED` , the streaming session can remain in the `STOPPED` state indefinitely. // // This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED` . When allowed, the default value for this parameter is `DEACTIVATED` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-automaticterminationmode // AutomaticTerminationMode *string `field:"optional" json:"automaticTerminationMode" yaml:"automaticTerminationMode"` // The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. // // After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxsessionlengthinminutes // // Default: - 690. // MaxSessionLengthInMinutes *float64 `field:"optional" json:"maxSessionLengthInMinutes" yaml:"maxSessionLengthInMinutes"` // Integer that determines if you can start and stop your sessions and how long a session can stay in the `STOPPED` state. // // The default value is 0. The maximum value is 5760. // // This field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED` . // // If the value is set to 0, your sessions can’t be `STOPPED` . If you then call `StopStreamingSession` , the session fails. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated (instead of `STOPPED` ). // // If the value is set to a positive number, the session can be stopped. You can call `StopStreamingSession` to stop sessions in the `READY` state. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped (instead of terminated). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxstoppedsessionlengthinminutes // // Default: - 0. // MaxStoppedSessionLengthInMinutes *float64 `field:"optional" json:"maxStoppedSessionLengthInMinutes" yaml:"maxStoppedSessionLengthInMinutes"` // Information about the streaming session backup. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionbackup // SessionBackup interface{} `field:"optional" json:"sessionBackup" yaml:"sessionBackup"` // Determine if a streaming session created from this launch profile can configure persistent storage. // // This means that `volumeConfiguration` and `automaticTerminationMode` are configured. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionpersistencemode // SessionPersistenceMode *string `field:"optional" json:"sessionPersistenceMode" yaml:"sessionPersistenceMode"` // The upload storage for a streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionstorage // SessionStorage interface{} `field:"optional" json:"sessionStorage" yaml:"sessionStorage"` // Custom volume configuration for the root volumes that are attached to streaming sessions. // // This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-volumeconfiguration // VolumeConfiguration interface{} `field:"optional" json:"volumeConfiguration" yaml:"volumeConfiguration"` }
A configuration for a streaming session.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamConfigurationProperty := &StreamConfigurationProperty{ ClipboardMode: jsii.String("clipboardMode"), Ec2InstanceTypes: []*string{ jsii.String("ec2InstanceTypes"), }, StreamingImageIds: []*string{ jsii.String("streamingImageIds"), }, // the properties below are optional AutomaticTerminationMode: jsii.String("automaticTerminationMode"), MaxSessionLengthInMinutes: jsii.Number(123), MaxStoppedSessionLengthInMinutes: jsii.Number(123), SessionBackup: &StreamConfigurationSessionBackupProperty{ MaxBackupsToRetain: jsii.Number(123), Mode: jsii.String("mode"), }, SessionPersistenceMode: jsii.String("sessionPersistenceMode"), SessionStorage: &StreamConfigurationSessionStorageProperty{ Mode: []*string{ jsii.String("mode"), }, // the properties below are optional Root: &StreamingSessionStorageRootProperty{ Linux: jsii.String("linux"), Windows: jsii.String("windows"), }, }, VolumeConfiguration: &VolumeConfigurationProperty{ Iops: jsii.Number(123), Size: jsii.Number(123), Throughput: jsii.Number(123), }, }
type CfnLaunchProfile_StreamConfigurationSessionBackupProperty ¶ added in v2.64.0
type CfnLaunchProfile_StreamConfigurationSessionBackupProperty struct { // The maximum number of backups that each streaming session created from this launch profile can have. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionbackup-maxbackupstoretain // // Default: - 0. // MaxBackupsToRetain *float64 `field:"optional" json:"maxBackupsToRetain" yaml:"maxBackupsToRetain"` // Specifies how artists sessions are backed up. // // Configures backups for streaming sessions launched with this launch profile. The default value is `DEACTIVATED` , which means that backups are deactivated. To allow backups, set this value to `AUTOMATIC` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionbackup-mode // Mode *string `field:"optional" json:"mode" yaml:"mode"` }
Configures how streaming sessions are backed up when launched from this launch profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamConfigurationSessionBackupProperty := &StreamConfigurationSessionBackupProperty{ MaxBackupsToRetain: jsii.Number(123), Mode: jsii.String("mode"), }
type CfnLaunchProfile_StreamConfigurationSessionStorageProperty ¶ added in v2.9.0
type CfnLaunchProfile_StreamConfigurationSessionStorageProperty struct { // Allows artists to upload files to their workstations. // // The only valid option is `UPLOAD` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionstorage-mode // Mode *[]*string `field:"required" json:"mode" yaml:"mode"` // The configuration for the upload storage root of the streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionstorage-root // Root interface{} `field:"optional" json:"root" yaml:"root"` }
The configuration for a streaming session’s upload storage.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamConfigurationSessionStorageProperty := &StreamConfigurationSessionStorageProperty{ Mode: []*string{ jsii.String("mode"), }, // the properties below are optional Root: &StreamingSessionStorageRootProperty{ Linux: jsii.String("linux"), Windows: jsii.String("windows"), }, }
type CfnLaunchProfile_StreamingSessionStorageRootProperty ¶ added in v2.9.0
type CfnLaunchProfile_StreamingSessionStorageRootProperty struct { // The folder path in Linux workstations where files are uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html#cfn-nimblestudio-launchprofile-streamingsessionstorageroot-linux // Linux *string `field:"optional" json:"linux" yaml:"linux"` // The folder path in Windows workstations where files are uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html#cfn-nimblestudio-launchprofile-streamingsessionstorageroot-windows // Windows *string `field:"optional" json:"windows" yaml:"windows"` }
The upload storage root location (folder) on streaming workstations where files are uploaded.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamingSessionStorageRootProperty := &StreamingSessionStorageRootProperty{ Linux: jsii.String("linux"), Windows: jsii.String("windows"), }
type CfnLaunchProfile_VolumeConfigurationProperty ¶ added in v2.58.1
type CfnLaunchProfile_VolumeConfigurationProperty struct { // The number of I/O operations per second for the root volume that is attached to streaming session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-iops // // Default: - 3000. // Iops *float64 `field:"optional" json:"iops" yaml:"iops"` // The size of the root volume that is attached to the streaming session. // // The root volume size is measured in GiBs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-size // // Default: - 500. // Size *float64 `field:"optional" json:"size" yaml:"size"` // The throughput to provision for the root volume that is attached to the streaming session. // // The throughput is measured in MiB/s. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-throughput // // Default: - 125. // Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"` }
Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" volumeConfigurationProperty := &VolumeConfigurationProperty{ Iops: jsii.Number(123), Size: jsii.Number(123), Throughput: jsii.Number(123), }
type CfnStreamingImage ¶
type CfnStreamingImage interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // <p>TODO</p>. AttrEncryptionConfiguration() awscdk.IResolvable AttrEncryptionConfigurationKeyArn() *string AttrEncryptionConfigurationKeyType() *string // The list of IDs of EULAs that must be accepted before a streaming session can be started using this streaming image. AttrEulaIds() *[]*string // The owner of the streaming image, either the studioId that contains the streaming image or 'amazon' for images that are provided by . AttrOwner() *string // The platform of the streaming image, either WINDOWS or LINUX. AttrPlatform() *string // The unique identifier for the streaming image resource. AttrStreamingImageId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A human-readable description of the streaming image. Description() *string SetDescription(val *string) // The ID of an EC2 machine image with which to create the streaming image. Ec2ImageId() *string SetEc2ImageId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A friendly name for a streaming image resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The unique identifier for a studio resource. StudioId() *string SetStudioId(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 "github.com/aws/aws-cdk-go/awscdk" cfnStreamingImage := awscdk.Aws_nimblestudio.NewCfnStreamingImage(this, jsii.String("MyCfnStreamingImage"), &CfnStreamingImageProps{ Ec2ImageId: jsii.String("ec2ImageId"), Name: jsii.String("name"), StudioId: jsii.String("studioId"), // the properties below are optional Description: jsii.String("description"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnStreamingImage ¶
func NewCfnStreamingImage(scope constructs.Construct, id *string, props *CfnStreamingImageProps) CfnStreamingImage
type CfnStreamingImageProps ¶
type CfnStreamingImageProps struct { // The ID of an EC2 machine image with which to create the streaming image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-streamingimage.html#cfn-nimblestudio-streamingimage-ec2imageid // Ec2ImageId *string `field:"required" json:"ec2ImageId" yaml:"ec2ImageId"` // A friendly name for a streaming image resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-streamingimage.html#cfn-nimblestudio-streamingimage-name // Name *string `field:"required" json:"name" yaml:"name"` // The unique identifier for a studio resource. // // In Nimble Studio, all other resources are contained in a studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-streamingimage.html#cfn-nimblestudio-streamingimage-studioid // StudioId *string `field:"required" json:"studioId" yaml:"studioId"` // A human-readable description of the streaming image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-streamingimage.html#cfn-nimblestudio-streamingimage-description // Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-streamingimage.html#cfn-nimblestudio-streamingimage-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnStreamingImage`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStreamingImageProps := &CfnStreamingImageProps{ Ec2ImageId: jsii.String("ec2ImageId"), Name: jsii.String("name"), StudioId: jsii.String("studioId"), // the properties below are optional Description: jsii.String("description"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnStreamingImage_StreamingImageEncryptionConfigurationProperty ¶ added in v2.55.0
type CfnStreamingImage_StreamingImageEncryptionConfigurationProperty struct { // The type of KMS key that is used to encrypt studio data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-streamingimage-streamingimageencryptionconfiguration.html#cfn-nimblestudio-streamingimage-streamingimageencryptionconfiguration-keytype // KeyType *string `field:"required" json:"keyType" yaml:"keyType"` // The ARN for a KMS key that is used to encrypt studio data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-streamingimage-streamingimageencryptionconfiguration.html#cfn-nimblestudio-streamingimage-streamingimageencryptionconfiguration-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Specifies how a streaming image is encrypted.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamingImageEncryptionConfigurationProperty := &StreamingImageEncryptionConfigurationProperty{ KeyType: jsii.String("keyType"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
type CfnStudio ¶
type CfnStudio interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The IAM role that studio admins assume when logging in to the Nimble Studio portal. AdminRoleArn() *string SetAdminRoleArn(val *string) // The AWS Region where the studio resource is located. // // For example, `us-west-2` . AttrHomeRegion() *string // The IAM Identity Center application client ID that is used to integrate with IAM Identity Center , which enables IAM Identity Center users to log into the portal. AttrSsoClientId() *string // The unique identifier for the studio resource. AttrStudioId() *string // The unique identifier for the studio resource. AttrStudioUrl() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A friendly name for the studio. DisplayName() *string SetDisplayName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Configuration of the encryption method that is used for the studio. StudioEncryptionConfiguration() interface{} SetStudioEncryptionConfiguration(val interface{}) // The name of the studio, as included in the URL when accessing it in the Nimble Studio portal. StudioName() *string SetStudioName(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The IAM role that studio users assume when logging in to the Nimble Studio portal. UserRoleArn() *string SetUserRoleArn(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::NimbleStudio::Studio` resource creates a new studio resource. In , all other resources are contained in a studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the portal. The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly. The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You can optionally specify an AWS Key Management Service key in the StudioEncryptionConfiguration. In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an AWS Key Management Service key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS Key Management Service key when calling CreateStudio to encrypt this data using a key that you own and manage. When providing an AWS Key Management Service key during studio creation, creates AWS Key Management Service grants in your account to provide your studio user and admin roles access to these AWS Key Management Service keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio AWS Key Management Service key, your studio will no longer be accessible.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudio := awscdk.Aws_nimblestudio.NewCfnStudio(this, jsii.String("MyCfnStudio"), &CfnStudioProps{ AdminRoleArn: jsii.String("adminRoleArn"), DisplayName: jsii.String("displayName"), StudioName: jsii.String("studioName"), UserRoleArn: jsii.String("userRoleArn"), // the properties below are optional StudioEncryptionConfiguration: &StudioEncryptionConfigurationProperty{ KeyType: jsii.String("keyType"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html
func NewCfnStudio ¶
func NewCfnStudio(scope constructs.Construct, id *string, props *CfnStudioProps) CfnStudio
type CfnStudioComponent ¶
type CfnStudioComponent interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The unique identifier for the studio component resource. AttrStudioComponentId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The configuration of the studio component, based on component type. Configuration() interface{} SetConfiguration(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A human-readable description for the studio component resource. Description() *string SetDescription(val *string) // The EC2 security groups that control access to the studio component. Ec2SecurityGroupIds() *[]*string SetEc2SecurityGroupIds(val *[]*string) // Initialization scripts for studio components. InitializationScripts() interface{} SetInitializationScripts(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A friendly name for the studio component resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running. RuntimeRoleArn() *string SetRuntimeRoleArn(val *string) // Parameters for the studio component scripts. ScriptParameters() interface{} SetScriptParameters(val interface{}) // An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs. SecureInitializationRoleArn() *string SetSecureInitializationRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The unique identifier for a studio resource. StudioId() *string SetStudioId(val *string) // The specific subtype of a studio component. Subtype() *string SetSubtype(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // The type of the studio component. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::NimbleStudio::StudioComponent` resource represents a network resource that is used by a studio's users and workflows.
A typical studio contains studio components for the following: a render farm, an Active Directory, a licensing service, and a shared file system.
Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.
A studio component also has a set of initialization scripts, which are returned by `GetLaunchProfileInitialization` . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how studio resources are configured on a streaming session.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudioComponent := awscdk.Aws_nimblestudio.NewCfnStudioComponent(this, jsii.String("MyCfnStudioComponent"), &CfnStudioComponentProps{ Name: jsii.String("name"), StudioId: jsii.String("studioId"), Type: jsii.String("type"), // the properties below are optional Configuration: &StudioComponentConfigurationProperty{ ActiveDirectoryConfiguration: &ActiveDirectoryConfigurationProperty{ ComputerAttributes: []interface{}{ &ActiveDirectoryComputerAttributeProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, DirectoryId: jsii.String("directoryId"), OrganizationalUnitDistinguishedName: jsii.String("organizationalUnitDistinguishedName"), }, ComputeFarmConfiguration: &ComputeFarmConfigurationProperty{ ActiveDirectoryUser: jsii.String("activeDirectoryUser"), Endpoint: jsii.String("endpoint"), }, LicenseServiceConfiguration: &LicenseServiceConfigurationProperty{ Endpoint: jsii.String("endpoint"), }, SharedFileSystemConfiguration: &SharedFileSystemConfigurationProperty{ Endpoint: jsii.String("endpoint"), FileSystemId: jsii.String("fileSystemId"), LinuxMountPoint: jsii.String("linuxMountPoint"), ShareName: jsii.String("shareName"), WindowsMountDrive: jsii.String("windowsMountDrive"), }, }, Description: jsii.String("description"), Ec2SecurityGroupIds: []*string{ jsii.String("ec2SecurityGroupIds"), }, InitializationScripts: []interface{}{ &StudioComponentInitializationScriptProperty{ LaunchProfileProtocolVersion: jsii.String("launchProfileProtocolVersion"), Platform: jsii.String("platform"), RunContext: jsii.String("runContext"), Script: jsii.String("script"), }, }, RuntimeRoleArn: jsii.String("runtimeRoleArn"), ScriptParameters: []interface{}{ &ScriptParameterKeyValueProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, SecureInitializationRoleArn: jsii.String("secureInitializationRoleArn"), Subtype: jsii.String("subtype"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnStudioComponent ¶
func NewCfnStudioComponent(scope constructs.Construct, id *string, props *CfnStudioComponentProps) CfnStudioComponent
type CfnStudioComponentProps ¶
type CfnStudioComponentProps struct { // A friendly name for the studio component resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-name // Name *string `field:"required" json:"name" yaml:"name"` // The unique identifier for a studio resource. // // In Nimble Studio, all other resources are contained in a studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-studioid // StudioId *string `field:"required" json:"studioId" yaml:"studioId"` // The type of the studio component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-type // Type *string `field:"required" json:"type" yaml:"type"` // The configuration of the studio component, based on component type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-configuration // Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"` // A human-readable description for the studio component resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-description // Description *string `field:"optional" json:"description" yaml:"description"` // The EC2 security groups that control access to the studio component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-ec2securitygroupids // Ec2SecurityGroupIds *[]*string `field:"optional" json:"ec2SecurityGroupIds" yaml:"ec2SecurityGroupIds"` // Initialization scripts for studio components. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-initializationscripts // InitializationScripts interface{} `field:"optional" json:"initializationScripts" yaml:"initializationScripts"` // An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-runtimerolearn // RuntimeRoleArn *string `field:"optional" json:"runtimeRoleArn" yaml:"runtimeRoleArn"` // Parameters for the studio component scripts. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-scriptparameters // ScriptParameters interface{} `field:"optional" json:"scriptParameters" yaml:"scriptParameters"` // An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-secureinitializationrolearn // SecureInitializationRoleArn *string `field:"optional" json:"secureInitializationRoleArn" yaml:"secureInitializationRoleArn"` // The specific subtype of a studio component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-subtype // Subtype *string `field:"optional" json:"subtype" yaml:"subtype"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html#cfn-nimblestudio-studiocomponent-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnStudioComponent`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudioComponentProps := &CfnStudioComponentProps{ Name: jsii.String("name"), StudioId: jsii.String("studioId"), Type: jsii.String("type"), // the properties below are optional Configuration: &StudioComponentConfigurationProperty{ ActiveDirectoryConfiguration: &ActiveDirectoryConfigurationProperty{ ComputerAttributes: []interface{}{ &ActiveDirectoryComputerAttributeProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, DirectoryId: jsii.String("directoryId"), OrganizationalUnitDistinguishedName: jsii.String("organizationalUnitDistinguishedName"), }, ComputeFarmConfiguration: &ComputeFarmConfigurationProperty{ ActiveDirectoryUser: jsii.String("activeDirectoryUser"), Endpoint: jsii.String("endpoint"), }, LicenseServiceConfiguration: &LicenseServiceConfigurationProperty{ Endpoint: jsii.String("endpoint"), }, SharedFileSystemConfiguration: &SharedFileSystemConfigurationProperty{ Endpoint: jsii.String("endpoint"), FileSystemId: jsii.String("fileSystemId"), LinuxMountPoint: jsii.String("linuxMountPoint"), ShareName: jsii.String("shareName"), WindowsMountDrive: jsii.String("windowsMountDrive"), }, }, Description: jsii.String("description"), Ec2SecurityGroupIds: []*string{ jsii.String("ec2SecurityGroupIds"), }, InitializationScripts: []interface{}{ &StudioComponentInitializationScriptProperty{ LaunchProfileProtocolVersion: jsii.String("launchProfileProtocolVersion"), Platform: jsii.String("platform"), RunContext: jsii.String("runContext"), Script: jsii.String("script"), }, }, RuntimeRoleArn: jsii.String("runtimeRoleArn"), ScriptParameters: []interface{}{ &ScriptParameterKeyValueProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, SecureInitializationRoleArn: jsii.String("secureInitializationRoleArn"), Subtype: jsii.String("subtype"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnStudioComponent_ActiveDirectoryComputerAttributeProperty ¶
type CfnStudioComponent_ActiveDirectoryComputerAttributeProperty struct { // The name for the LDAP attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html#cfn-nimblestudio-studiocomponent-activedirectorycomputerattribute-name // Name *string `field:"optional" json:"name" yaml:"name"` // The value for the LDAP attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html#cfn-nimblestudio-studiocomponent-activedirectorycomputerattribute-value // Value *string `field:"optional" json:"value" yaml:"value"` }
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" activeDirectoryComputerAttributeProperty := &ActiveDirectoryComputerAttributeProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnStudioComponent_ActiveDirectoryConfigurationProperty ¶
type CfnStudioComponent_ActiveDirectoryConfigurationProperty struct { // A collection of custom attributes for an Active Directory computer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-computerattributes // ComputerAttributes interface{} `field:"optional" json:"computerAttributes" yaml:"computerAttributes"` // The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-directoryid // DirectoryId *string `field:"optional" json:"directoryId" yaml:"directoryId"` // The distinguished name (DN) and organizational unit (OU) of an Active Directory computer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-organizationalunitdistinguishedname // OrganizationalUnitDistinguishedName *string `field:"optional" json:"organizationalUnitDistinguishedName" yaml:"organizationalUnitDistinguishedName"` }
The configuration for a AWS Directory Service for Microsoft Active Directory studio resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" activeDirectoryConfigurationProperty := &ActiveDirectoryConfigurationProperty{ ComputerAttributes: []interface{}{ &ActiveDirectoryComputerAttributeProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, DirectoryId: jsii.String("directoryId"), OrganizationalUnitDistinguishedName: jsii.String("organizationalUnitDistinguishedName"), }
type CfnStudioComponent_ComputeFarmConfigurationProperty ¶
type CfnStudioComponent_ComputeFarmConfigurationProperty struct { // The name of an Active Directory user that is used on ComputeFarm worker instances. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html#cfn-nimblestudio-studiocomponent-computefarmconfiguration-activedirectoryuser // ActiveDirectoryUser *string `field:"optional" json:"activeDirectoryUser" yaml:"activeDirectoryUser"` // The endpoint of the ComputeFarm that is accessed by the studio component resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html#cfn-nimblestudio-studiocomponent-computefarmconfiguration-endpoint // Endpoint *string `field:"optional" json:"endpoint" yaml:"endpoint"` }
The configuration for a render farm that is associated with a studio resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" computeFarmConfigurationProperty := &ComputeFarmConfigurationProperty{ ActiveDirectoryUser: jsii.String("activeDirectoryUser"), Endpoint: jsii.String("endpoint"), }
type CfnStudioComponent_LicenseServiceConfigurationProperty ¶
type CfnStudioComponent_LicenseServiceConfigurationProperty struct { // The endpoint of the license service that is accessed by the studio component resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-licenseserviceconfiguration.html#cfn-nimblestudio-studiocomponent-licenseserviceconfiguration-endpoint // Endpoint *string `field:"optional" json:"endpoint" yaml:"endpoint"` }
The configuration for a license service that is associated with a studio resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" licenseServiceConfigurationProperty := &LicenseServiceConfigurationProperty{ Endpoint: jsii.String("endpoint"), }
type CfnStudioComponent_ScriptParameterKeyValueProperty ¶
type CfnStudioComponent_ScriptParameterKeyValueProperty struct { // A script parameter key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-scriptparameterkeyvalue.html#cfn-nimblestudio-studiocomponent-scriptparameterkeyvalue-key // Key *string `field:"optional" json:"key" yaml:"key"` // A script parameter value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-scriptparameterkeyvalue.html#cfn-nimblestudio-studiocomponent-scriptparameterkeyvalue-value // Value *string `field:"optional" json:"value" yaml:"value"` }
A parameter for a studio component script, in the form of a key-value pair.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scriptParameterKeyValueProperty := &ScriptParameterKeyValueProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }
type CfnStudioComponent_SharedFileSystemConfigurationProperty ¶
type CfnStudioComponent_SharedFileSystemConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-endpoint // Endpoint *string `field:"optional" json:"endpoint" yaml:"endpoint"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-filesystemid // FileSystemId *string `field:"optional" json:"fileSystemId" yaml:"fileSystemId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-linuxmountpoint // LinuxMountPoint *string `field:"optional" json:"linuxMountPoint" yaml:"linuxMountPoint"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-sharename // ShareName *string `field:"optional" json:"shareName" yaml:"shareName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-windowsmountdrive // WindowsMountDrive *string `field:"optional" json:"windowsMountDrive" yaml:"windowsMountDrive"` }
The configuration for a shared file storage system that is associated with a studio resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sharedFileSystemConfigurationProperty := &SharedFileSystemConfigurationProperty{ Endpoint: jsii.String("endpoint"), FileSystemId: jsii.String("fileSystemId"), LinuxMountPoint: jsii.String("linuxMountPoint"), ShareName: jsii.String("shareName"), WindowsMountDrive: jsii.String("windowsMountDrive"), }
type CfnStudioComponent_StudioComponentConfigurationProperty ¶
type CfnStudioComponent_StudioComponentConfigurationProperty struct { // The configuration for a AWS Directory Service for Microsoft Active Directory studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-activedirectoryconfiguration // ActiveDirectoryConfiguration interface{} `field:"optional" json:"activeDirectoryConfiguration" yaml:"activeDirectoryConfiguration"` // The configuration for a render farm that is associated with a studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-computefarmconfiguration // ComputeFarmConfiguration interface{} `field:"optional" json:"computeFarmConfiguration" yaml:"computeFarmConfiguration"` // The configuration for a license service that is associated with a studio resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-licenseserviceconfiguration // LicenseServiceConfiguration interface{} `field:"optional" json:"licenseServiceConfiguration" yaml:"licenseServiceConfiguration"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-sharedfilesystemconfiguration // SharedFileSystemConfiguration interface{} `field:"optional" json:"sharedFileSystemConfiguration" yaml:"sharedFileSystemConfiguration"` }
The configuration of the studio component, based on component type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" studioComponentConfigurationProperty := &StudioComponentConfigurationProperty{ ActiveDirectoryConfiguration: &ActiveDirectoryConfigurationProperty{ ComputerAttributes: []interface{}{ &ActiveDirectoryComputerAttributeProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, DirectoryId: jsii.String("directoryId"), OrganizationalUnitDistinguishedName: jsii.String("organizationalUnitDistinguishedName"), }, ComputeFarmConfiguration: &ComputeFarmConfigurationProperty{ ActiveDirectoryUser: jsii.String("activeDirectoryUser"), Endpoint: jsii.String("endpoint"), }, LicenseServiceConfiguration: &LicenseServiceConfigurationProperty{ Endpoint: jsii.String("endpoint"), }, SharedFileSystemConfiguration: &SharedFileSystemConfigurationProperty{ Endpoint: jsii.String("endpoint"), FileSystemId: jsii.String("fileSystemId"), LinuxMountPoint: jsii.String("linuxMountPoint"), ShareName: jsii.String("shareName"), WindowsMountDrive: jsii.String("windowsMountDrive"), }, }
type CfnStudioComponent_StudioComponentInitializationScriptProperty ¶
type CfnStudioComponent_StudioComponentInitializationScriptProperty struct { // The version number of the protocol that is used by the launch profile. // // The only valid version is "2021-03-31". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-launchprofileprotocolversion // LaunchProfileProtocolVersion *string `field:"optional" json:"launchProfileProtocolVersion" yaml:"launchProfileProtocolVersion"` // The platform of the initialization script, either Windows or Linux. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-platform // Platform *string `field:"optional" json:"platform" yaml:"platform"` // The method to use when running the initialization script. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-runcontext // RunContext *string `field:"optional" json:"runContext" yaml:"runContext"` // The initialization script. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-script // Script *string `field:"optional" json:"script" yaml:"script"` }
Initialization scripts for studio components.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" studioComponentInitializationScriptProperty := &StudioComponentInitializationScriptProperty{ LaunchProfileProtocolVersion: jsii.String("launchProfileProtocolVersion"), Platform: jsii.String("platform"), RunContext: jsii.String("runContext"), Script: jsii.String("script"), }
type CfnStudioProps ¶
type CfnStudioProps struct { // The IAM role that studio admins assume when logging in to the Nimble Studio portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-adminrolearn // AdminRoleArn *string `field:"required" json:"adminRoleArn" yaml:"adminRoleArn"` // A friendly name for the studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The name of the studio, as included in the URL when accessing it in the Nimble Studio portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-studioname // StudioName *string `field:"required" json:"studioName" yaml:"studioName"` // The IAM role that studio users assume when logging in to the Nimble Studio portal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-userrolearn // UserRoleArn *string `field:"required" json:"userRoleArn" yaml:"userRoleArn"` // Configuration of the encryption method that is used for the studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-studioencryptionconfiguration // StudioEncryptionConfiguration interface{} `field:"optional" json:"studioEncryptionConfiguration" yaml:"studioEncryptionConfiguration"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html#cfn-nimblestudio-studio-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnStudio`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudioProps := &CfnStudioProps{ AdminRoleArn: jsii.String("adminRoleArn"), DisplayName: jsii.String("displayName"), StudioName: jsii.String("studioName"), UserRoleArn: jsii.String("userRoleArn"), // the properties below are optional StudioEncryptionConfiguration: &StudioEncryptionConfigurationProperty{ KeyType: jsii.String("keyType"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html
type CfnStudio_StudioEncryptionConfigurationProperty ¶
type CfnStudio_StudioEncryptionConfigurationProperty struct { // The type of KMS key that is used to encrypt studio data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studio-studioencryptionconfiguration.html#cfn-nimblestudio-studio-studioencryptionconfiguration-keytype // KeyType *string `field:"required" json:"keyType" yaml:"keyType"` // The ARN for a KMS key that is used to encrypt studio data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studio-studioencryptionconfiguration.html#cfn-nimblestudio-studio-studioencryptionconfiguration-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Configuration of the encryption method that is used for the studio.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" studioEncryptionConfigurationProperty := &StudioEncryptionConfigurationProperty{ KeyType: jsii.String("keyType"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
Source Files ¶
- CfnLaunchProfile.go
- CfnLaunchProfileProps.go
- CfnLaunchProfile_StreamConfigurationProperty.go
- CfnLaunchProfile_StreamConfigurationSessionBackupProperty.go
- CfnLaunchProfile_StreamConfigurationSessionStorageProperty.go
- CfnLaunchProfile_StreamingSessionStorageRootProperty.go
- CfnLaunchProfile_VolumeConfigurationProperty.go
- CfnLaunchProfile__checks.go
- CfnStreamingImage.go
- CfnStreamingImageProps.go
- CfnStreamingImage_StreamingImageEncryptionConfigurationProperty.go
- CfnStreamingImage__checks.go
- CfnStudio.go
- CfnStudioComponent.go
- CfnStudioComponentProps.go
- CfnStudioComponent_ActiveDirectoryComputerAttributeProperty.go
- CfnStudioComponent_ActiveDirectoryConfigurationProperty.go
- CfnStudioComponent_ComputeFarmConfigurationProperty.go
- CfnStudioComponent_LicenseServiceConfigurationProperty.go
- CfnStudioComponent_ScriptParameterKeyValueProperty.go
- CfnStudioComponent_SharedFileSystemConfigurationProperty.go
- CfnStudioComponent_StudioComponentConfigurationProperty.go
- CfnStudioComponent_StudioComponentInitializationScriptProperty.go
- CfnStudioComponent__checks.go
- CfnStudioProps.go
- CfnStudio_StudioEncryptionConfigurationProperty.go
- CfnStudio__checks.go
- main.go