commonMain.aws.sdk.kotlin.services.nimble.model.StudioComponent.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nimble-jvm Show documentation
Show all versions of nimble-jvm Show documentation
The AWS SDK for Kotlin client for nimble
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.nimble.model
import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant
/**
* A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and 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 that are returned by `GetLaunchProfileInitialization`. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.
*/
public class StudioComponent private constructor(builder: Builder) {
/**
* The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
*/
public val arn: kotlin.String? = builder.arn
/**
* The configuration of the studio component, based on component type.
*/
public val configuration: aws.sdk.kotlin.services.nimble.model.StudioComponentConfiguration? = builder.configuration
/**
* The ISO timestamp in seconds for when the resource was created.
*/
public val createdAt: aws.smithy.kotlin.runtime.time.Instant? = builder.createdAt
/**
* The user ID of the user that created the studio component.
*/
public val createdBy: kotlin.String? = builder.createdBy
/**
* A human-readable description for the studio component resource.
*/
public val description: kotlin.String? = builder.description
/**
* The EC2 security groups that control access to the studio component.
*/
public val ec2SecurityGroupIds: List? = builder.ec2SecurityGroupIds
/**
* Initialization scripts for studio components.
*/
public val initializationScripts: List? = builder.initializationScripts
/**
* A friendly name for the studio component resource.
*/
public val name: kotlin.String? = builder.name
/**
* An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
*/
public val runtimeRoleArn: kotlin.String? = builder.runtimeRoleArn
/**
* Parameters for the studio component scripts.
*/
public val scriptParameters: List? = builder.scriptParameters
/**
* An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
*/
public val secureInitializationRoleArn: kotlin.String? = builder.secureInitializationRoleArn
/**
* The current state.
*/
public val state: aws.sdk.kotlin.services.nimble.model.StudioComponentState? = builder.state
/**
* The status code.
*/
public val statusCode: aws.sdk.kotlin.services.nimble.model.StudioComponentStatusCode? = builder.statusCode
/**
* The status message for the studio component.
*/
public val statusMessage: kotlin.String? = builder.statusMessage
/**
* The unique identifier for a studio component resource.
*/
public val studioComponentId: kotlin.String? = builder.studioComponentId
/**
* The specific subtype of a studio component.
*/
public val subtype: aws.sdk.kotlin.services.nimble.model.StudioComponentSubtype? = builder.subtype
/**
* A collection of labels, in the form of key-value pairs, that apply to this resource.
*/
public val tags: Map? = builder.tags
/**
* The type of the studio component.
*/
public val type: aws.sdk.kotlin.services.nimble.model.StudioComponentType? = builder.type
/**
* The ISO timestamp in seconds for when the resource was updated.
*/
public val updatedAt: aws.smithy.kotlin.runtime.time.Instant? = builder.updatedAt
/**
* The user ID of the user that most recently updated the resource.
*/
public val updatedBy: kotlin.String? = builder.updatedBy
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.nimble.model.StudioComponent = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("StudioComponent(")
append("arn=$arn,")
append("configuration=$configuration,")
append("createdAt=$createdAt,")
append("createdBy=$createdBy,")
append("description=*** Sensitive Data Redacted ***,")
append("ec2SecurityGroupIds=$ec2SecurityGroupIds,")
append("initializationScripts=$initializationScripts,")
append("name=*** Sensitive Data Redacted ***,")
append("runtimeRoleArn=$runtimeRoleArn,")
append("scriptParameters=*** Sensitive Data Redacted ***,")
append("secureInitializationRoleArn=$secureInitializationRoleArn,")
append("state=$state,")
append("statusCode=$statusCode,")
append("statusMessage=$statusMessage,")
append("studioComponentId=$studioComponentId,")
append("subtype=$subtype,")
append("tags=$tags,")
append("type=$type,")
append("updatedAt=$updatedAt,")
append("updatedBy=$updatedBy")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = arn?.hashCode() ?: 0
result = 31 * result + (configuration?.hashCode() ?: 0)
result = 31 * result + (createdAt?.hashCode() ?: 0)
result = 31 * result + (createdBy?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (ec2SecurityGroupIds?.hashCode() ?: 0)
result = 31 * result + (initializationScripts?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (runtimeRoleArn?.hashCode() ?: 0)
result = 31 * result + (scriptParameters?.hashCode() ?: 0)
result = 31 * result + (secureInitializationRoleArn?.hashCode() ?: 0)
result = 31 * result + (state?.hashCode() ?: 0)
result = 31 * result + (statusCode?.hashCode() ?: 0)
result = 31 * result + (statusMessage?.hashCode() ?: 0)
result = 31 * result + (studioComponentId?.hashCode() ?: 0)
result = 31 * result + (subtype?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
result = 31 * result + (type?.hashCode() ?: 0)
result = 31 * result + (updatedAt?.hashCode() ?: 0)
result = 31 * result + (updatedBy?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as StudioComponent
if (arn != other.arn) return false
if (configuration != other.configuration) return false
if (createdAt != other.createdAt) return false
if (createdBy != other.createdBy) return false
if (description != other.description) return false
if (ec2SecurityGroupIds != other.ec2SecurityGroupIds) return false
if (initializationScripts != other.initializationScripts) return false
if (name != other.name) return false
if (runtimeRoleArn != other.runtimeRoleArn) return false
if (scriptParameters != other.scriptParameters) return false
if (secureInitializationRoleArn != other.secureInitializationRoleArn) return false
if (state != other.state) return false
if (statusCode != other.statusCode) return false
if (statusMessage != other.statusMessage) return false
if (studioComponentId != other.studioComponentId) return false
if (subtype != other.subtype) return false
if (tags != other.tags) return false
if (type != other.type) return false
if (updatedAt != other.updatedAt) return false
if (updatedBy != other.updatedBy) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.nimble.model.StudioComponent = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
*/
public var arn: kotlin.String? = null
/**
* The configuration of the studio component, based on component type.
*/
public var configuration: aws.sdk.kotlin.services.nimble.model.StudioComponentConfiguration? = null
/**
* The ISO timestamp in seconds for when the resource was created.
*/
public var createdAt: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The user ID of the user that created the studio component.
*/
public var createdBy: kotlin.String? = null
/**
* A human-readable description for the studio component resource.
*/
public var description: kotlin.String? = null
/**
* The EC2 security groups that control access to the studio component.
*/
public var ec2SecurityGroupIds: List? = null
/**
* Initialization scripts for studio components.
*/
public var initializationScripts: List? = null
/**
* A friendly name for the studio component resource.
*/
public var name: kotlin.String? = null
/**
* An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
*/
public var runtimeRoleArn: kotlin.String? = null
/**
* Parameters for the studio component scripts.
*/
public var scriptParameters: List? = null
/**
* An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
*/
public var secureInitializationRoleArn: kotlin.String? = null
/**
* The current state.
*/
public var state: aws.sdk.kotlin.services.nimble.model.StudioComponentState? = null
/**
* The status code.
*/
public var statusCode: aws.sdk.kotlin.services.nimble.model.StudioComponentStatusCode? = null
/**
* The status message for the studio component.
*/
public var statusMessage: kotlin.String? = null
/**
* The unique identifier for a studio component resource.
*/
public var studioComponentId: kotlin.String? = null
/**
* The specific subtype of a studio component.
*/
public var subtype: aws.sdk.kotlin.services.nimble.model.StudioComponentSubtype? = null
/**
* A collection of labels, in the form of key-value pairs, that apply to this resource.
*/
public var tags: Map? = null
/**
* The type of the studio component.
*/
public var type: aws.sdk.kotlin.services.nimble.model.StudioComponentType? = null
/**
* The ISO timestamp in seconds for when the resource was updated.
*/
public var updatedAt: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The user ID of the user that most recently updated the resource.
*/
public var updatedBy: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.nimble.model.StudioComponent) : this() {
this.arn = x.arn
this.configuration = x.configuration
this.createdAt = x.createdAt
this.createdBy = x.createdBy
this.description = x.description
this.ec2SecurityGroupIds = x.ec2SecurityGroupIds
this.initializationScripts = x.initializationScripts
this.name = x.name
this.runtimeRoleArn = x.runtimeRoleArn
this.scriptParameters = x.scriptParameters
this.secureInitializationRoleArn = x.secureInitializationRoleArn
this.state = x.state
this.statusCode = x.statusCode
this.statusMessage = x.statusMessage
this.studioComponentId = x.studioComponentId
this.subtype = x.subtype
this.tags = x.tags
this.type = x.type
this.updatedAt = x.updatedAt
this.updatedBy = x.updatedBy
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.nimble.model.StudioComponent = StudioComponent(this)
internal fun correctErrors(): Builder {
return this
}
}
}