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_FromStudioId(scope constructs.Construct, id *string, studioId *string) interfacesawsnimblestudio.IStudioRef
- 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_FromStudioId ¶ added in v2.218.0
func CfnStudio_FromStudioId(scope constructs.Construct, id *string, studioId *string) interfacesawsnimblestudio.IStudioRef
Creates a new IStudioRef from a studioId.
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)
Create a new `AWS::NimbleStudio::LaunchProfile`.
func NewCfnStreamingImage_Override ¶
func NewCfnStreamingImage_Override(c CfnStreamingImage, scope constructs.Construct, id *string, props *CfnStreamingImageProps)
Create a new `AWS::NimbleStudio::StreamingImage`.
func NewCfnStudioComponent_Override ¶
func NewCfnStudioComponent_Override(c CfnStudioComponent, scope constructs.Construct, id *string, props *CfnStudioComponentProps)
Create a new `AWS::NimbleStudio::StudioComponent`.
func NewCfnStudio_Override ¶
func NewCfnStudio_Override(c CfnStudio, scope constructs.Construct, id *string, props *CfnStudioProps)
Create a new `AWS::NimbleStudio::Studio`.
Types ¶
type CfnLaunchProfile ¶
type CfnLaunchProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsnimblestudio.ILaunchProfileRef
awscdk.ITaggable
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
Description() *string
SetDescription(val *string)
Ec2SubnetIds() *[]*string
SetEc2SubnetIds(val *[]*string)
Env() *interfaces.ResourceEnvironment
LaunchProfileProtocolVersions() *[]*string
SetLaunchProfileProtocolVersions(val *[]*string)
// A reference to a LaunchProfile resource.
LaunchProfileRef() *interfacesawsnimblestudio.LaunchProfileReference
// 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
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
StreamConfiguration() interface{}
SetStreamConfiguration(val interface{})
StudioComponentIds() *[]*string
SetStudioComponentIds(val *[]*string)
StudioId() *string
SetStudioId(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
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{})
}
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
Create a new `AWS::NimbleStudio::LaunchProfile`.
type CfnLaunchProfileProps ¶
type CfnLaunchProfileProps struct {
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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 {
// 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"`
// 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"`
// 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"`
// 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"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxsessionlengthinminutes
//
MaxSessionLengthInMinutes *float64 `field:"optional" json:"maxSessionLengthInMinutes" yaml:"maxSessionLengthInMinutes"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxstoppedsessionlengthinminutes
//
MaxStoppedSessionLengthInMinutes *float64 `field:"optional" json:"maxStoppedSessionLengthInMinutes" yaml:"maxStoppedSessionLengthInMinutes"`
// 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"`
// 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"`
// 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"`
// 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"`
}
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 {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionbackup-maxbackupstoretain
//
MaxBackupsToRetain *float64 `field:"optional" json:"maxBackupsToRetain" yaml:"maxBackupsToRetain"`
// 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"`
}
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 {
// 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"`
// 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"`
}
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 {
// 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"`
// 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"`
}
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 {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-iops
//
Iops *float64 `field:"optional" json:"iops" yaml:"iops"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-size
//
Size *float64 `field:"optional" json:"size" yaml:"size"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-throughput
//
Throughput *float64 `field:"optional" json:"throughput" yaml:"throughput"`
}
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
interfacesawsnimblestudio.IStreamingImageRef
awscdk.ITaggable
AttrEncryptionConfiguration() awscdk.IResolvable
AttrEncryptionConfigurationKeyArn() *string
AttrEncryptionConfigurationKeyType() *string
AttrEulaIds() *[]*string
AttrOwner() *string
AttrPlatform() *string
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
Description() *string
SetDescription(val *string)
Ec2ImageId() *string
SetEc2ImageId(val *string)
Env() *interfaces.ResourceEnvironment
// 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
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 reference to a StreamingImage resource.
StreamingImageRef() *interfacesawsnimblestudio.StreamingImageReference
StudioId() *string
SetStudioId(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
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{})
}
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
Create a new `AWS::NimbleStudio::StreamingImage`.
type CfnStreamingImageProps ¶
type CfnStreamingImageProps struct {
// 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"`
// 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"`
// 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"`
// 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"`
// 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 {
// 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"`
// 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"`
}
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
interfacesawsnimblestudio.IStudioRef
awscdk.ITaggable
// <p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>.
AdminRoleArn() *string
SetAdminRoleArn(val *string)
// <p>The Amazon Web Services Region where the studio resource is located.</p>.
AttrHomeRegion() *string
// <p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>.
AttrSsoClientId() *string
AttrStudioId() *string
// <p>The address of the web page for the studio.</p>.
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
// <p>A friendly name for the studio.</p>.
DisplayName() *string
SetDisplayName(val *string)
Env() *interfaces.ResourceEnvironment
// 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
// <p>Configuration of the encryption method that is used for the studio.</p>.
StudioEncryptionConfiguration() interface{}
SetStudioEncryptionConfiguration(val interface{})
// <p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>.
StudioName() *string
SetStudioName(val *string)
// A reference to a Studio resource.
StudioRef() *interfacesawsnimblestudio.StudioReference
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
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{}
// <p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>.
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{})
}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.
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
Create a new `AWS::NimbleStudio::Studio`.
type CfnStudioComponent ¶
type CfnStudioComponent interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsnimblestudio.IStudioComponentRef
awscdk.ITaggable
AttrStudioComponentId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
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
Description() *string
SetDescription(val *string)
Ec2SecurityGroupIds() *[]*string
SetEc2SecurityGroupIds(val *[]*string)
Env() *interfaces.ResourceEnvironment
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
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
ScriptParameters() interface{}
SetScriptParameters(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A reference to a StudioComponent resource.
StudioComponentRef() *interfacesawsnimblestudio.StudioComponentReference
StudioId() *string
SetStudioId(val *string)
Subtype() *string
SetSubtype(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
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{})
}
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"),
},
},
ScriptParameters: []interface{}{
&ScriptParameterKeyValueProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Subtype: jsii.String("subtype"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnStudioComponent ¶
func NewCfnStudioComponent(scope constructs.Construct, id *string, props *CfnStudioComponentProps) CfnStudioComponent
Create a new `AWS::NimbleStudio::StudioComponent`.
type CfnStudioComponentProps ¶
type CfnStudioComponentProps struct {
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"`
// 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"),
},
},
ScriptParameters: []interface{}{
&ScriptParameterKeyValueProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Subtype: jsii.String("subtype"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnStudioComponent_ActiveDirectoryComputerAttributeProperty ¶
type CfnStudioComponent_ActiveDirectoryComputerAttributeProperty struct {
// 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"`
// 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"`
}
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 {
// 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"`
// 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"`
// 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"`
}
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 {
// 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"`
// 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"`
}
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 {
// 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"`
}
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 {
// 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"`
// 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"`
}
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 {
//
Endpoint *string `field:"optional" json:"endpoint" yaml:"endpoint"`
//
FileSystemId *string `field:"optional" json:"fileSystemId" yaml:"fileSystemId"`
//
LinuxMountPoint *string `field:"optional" json:"linuxMountPoint" yaml:"linuxMountPoint"`
//
ShareName *string `field:"optional" json:"shareName" yaml:"shareName"`
//
WindowsMountDrive *string `field:"optional" json:"windowsMountDrive" yaml:"windowsMountDrive"`
}
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 {
// 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"`
// 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"`
// 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"`
//
SharedFileSystemConfiguration interface{} `field:"optional" json:"sharedFileSystemConfiguration" yaml:"sharedFileSystemConfiguration"`
}
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 {
// 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"`
// 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"`
// 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"`
// 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"`
}
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 {
// <p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>.
// 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"`
// <p>A friendly name for the studio.</p>.
// 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"`
// <p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>.
// 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"`
// <p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>.
// 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"`
// <p>Configuration of the encryption method that is used for the studio.</p>.
// 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"`
// 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 {
// <p>The type of KMS key that is used to encrypt studio data.</p>.
// 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"`
// <p>The ARN for a KMS key that is used to encrypt studio data.</p>.
// 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"`
}
<p>Configuration of the encryption method that is used for the studio.</p>.
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