1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package appstream
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/appstream/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the specified fleet. If the fleet is in the STOPPED state, you can
// update any attribute except the fleet name. If the fleet is in the RUNNING
// state, you can update the following based on the fleet type:
// - Always-On and On-Demand fleet types You can update the DisplayName ,
// ComputeCapacity , ImageARN , ImageName , IdleDisconnectTimeoutInSeconds , and
// DisconnectTimeoutInSeconds attributes.
// - Elastic fleet type You can update the DisplayName ,
// IdleDisconnectTimeoutInSeconds , DisconnectTimeoutInSeconds ,
// MaxConcurrentSessions , SessionScriptS3Location and UsbDeviceFilterStrings
// attributes.
//
// If the fleet is in the STARTING or STOPPED state, you can't update it.
func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error) {
if params == nil {
params = &UpdateFleetInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateFleet", params, optFns, c.addOperationUpdateFleetMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateFleetOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateFleetInput struct {
// The fleet attributes to delete.
AttributesToDelete []types.FleetAttribute
// The desired capacity for the fleet. This is not allowed for Elastic fleets.
ComputeCapacity *types.ComputeCapacity
// Deletes the VPC association for the specified fleet.
//
// Deprecated: This member has been deprecated.
DeleteVpcConfig *bool
// The description to display.
Description *string
// The amount of time that a streaming session remains active after users
// disconnect. If users try to reconnect to the streaming session after a
// disconnection or network interruption within this time interval, they are
// connected to their previous session. Otherwise, they are connected to a new
// session with a new streaming instance. Specify a value between 60 and 360000.
DisconnectTimeoutInSeconds *int32
// The fleet name to display.
DisplayName *string
// The name of the directory and organizational unit (OU) to use to join the fleet
// to a Microsoft Active Directory domain.
DomainJoinInfo *types.DomainJoinInfo
// Enables or disables default internet access for the fleet.
EnableDefaultInternetAccess *bool
// The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume
// a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole
// API operation and passes the ARN of the role to use. The operation creates a new
// session with temporary credentials. AppStream 2.0 retrieves the temporary
// credentials and creates the appstream_machine_role credential profile on the
// instance. For more information, see Using an IAM Role to Grant Permissions to
// Applications and Scripts Running on AppStream 2.0 Streaming Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html)
// in the Amazon AppStream 2.0 Administration Guide.
IamRoleArn *string
// The amount of time that users can be idle (inactive) before they are
// disconnected from their streaming session and the DisconnectTimeoutInSeconds
// time interval begins. Users are notified before they are disconnected due to
// inactivity. If users try to reconnect to the streaming session before the time
// interval specified in DisconnectTimeoutInSeconds elapses, they are connected to
// their previous session. Users are considered idle when they stop providing
// keyboard or mouse input during their streaming session. File uploads and
// downloads, audio in, audio out, and pixels changing do not qualify as user
// activity. If users continue to be idle after the time interval in
// IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users
// from being disconnected due to inactivity, specify a value of 0. Otherwise,
// specify a value between 60 and 3600. The default value is 0. If you enable this
// feature, we recommend that you specify a value that corresponds exactly to a
// whole number of minutes (for example, 60, 120, and 180). If you don't do this,
// the value is rounded to the nearest minute. For example, if you specify a value
// of 70, users are disconnected after 1 minute of inactivity. If you specify a
// value that is at the midpoint between two different minutes, the value is
// rounded up. For example, if you specify a value of 90, users are disconnected
// after 2 minutes of inactivity.
IdleDisconnectTimeoutInSeconds *int32
// The ARN of the public, private, or shared image to use.
ImageArn *string
// The name of the image used to create the fleet.
ImageName *string
// The instance type to use when launching fleet instances. The following instance
// types are available:
// - stream.standard.small
// - stream.standard.medium
// - stream.standard.large
// - stream.standard.xlarge
// - stream.standard.2xlarge
// - stream.compute.large
// - stream.compute.xlarge
// - stream.compute.2xlarge
// - stream.compute.4xlarge
// - stream.compute.8xlarge
// - stream.memory.large
// - stream.memory.xlarge
// - stream.memory.2xlarge
// - stream.memory.4xlarge
// - stream.memory.8xlarge
// - stream.memory.z1d.large
// - stream.memory.z1d.xlarge
// - stream.memory.z1d.2xlarge
// - stream.memory.z1d.3xlarge
// - stream.memory.z1d.6xlarge
// - stream.memory.z1d.12xlarge
// - stream.graphics-design.large
// - stream.graphics-design.xlarge
// - stream.graphics-design.2xlarge
// - stream.graphics-design.4xlarge
// - stream.graphics-desktop.2xlarge
// - stream.graphics.g4dn.xlarge
// - stream.graphics.g4dn.2xlarge
// - stream.graphics.g4dn.4xlarge
// - stream.graphics.g4dn.8xlarge
// - stream.graphics.g4dn.12xlarge
// - stream.graphics.g4dn.16xlarge
// - stream.graphics-pro.4xlarge
// - stream.graphics-pro.8xlarge
// - stream.graphics-pro.16xlarge
// The following instance types are available for Elastic fleets:
// - stream.standard.small
// - stream.standard.medium
// - stream.standard.large
// - stream.standard.xlarge
// - stream.standard.2xlarge
InstanceType *string
// The maximum number of concurrent sessions for a fleet.
MaxConcurrentSessions *int32
// The maximum number of user sessions on an instance. This only applies to
// multi-session fleets.
MaxSessionsPerInstance *int32
// The maximum amount of time that a streaming session can remain active, in
// seconds. If users are still connected to a streaming instance five minutes
// before this limit is reached, they are prompted to save any open documents
// before being disconnected. After this time elapses, the instance is terminated
// and replaced by a new instance. Specify a value between 600 and 432000.
MaxUserDurationInSeconds *int32
// A unique name for the fleet.
Name *string
// The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported
// for Elastic fleets.
Platform types.PlatformType
// The S3 location of the session scripts configuration zip file. This only
// applies to Elastic fleets.
SessionScriptS3Location *types.S3Location
// The AppStream 2.0 view that is displayed to your users when they stream from
// the fleet. When APP is specified, only the windows of applications opened by
// users display. When DESKTOP is specified, the standard desktop that is provided
// by the operating system displays. The default value is APP .
StreamView types.StreamView
// The USB device filter strings that specify which USB devices a user can
// redirect to the fleet streaming session, when using the Windows native client.
// This is allowed but not required for Elastic fleets.
UsbDeviceFilterStrings []string
// The VPC configuration for the fleet. This is required for Elastic fleets, but
// not required for other fleet types. Elastic fleets require that you specify at
// least two subnets in different availability zones.
VpcConfig *types.VpcConfig
noSmithyDocumentSerde
}
type UpdateFleetOutput struct {
// Information about the fleet.
Fleet *types.Fleet
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateFleetMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateFleet{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateFleet{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateFleet"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateFleetValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateFleet(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateFleet(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateFleet",
}
}
|