Amazonka.AutoScaling.StartInstanceRefresh

Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.

This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.

If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.

Creating a Request

data StartInstanceRefresh

See: newStartInstanceRefresh smart constructor.

Constructors

StartInstanceRefresh'

Fields

• desiredConfiguration :: Maybe DesiredConfiguration

  The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

  Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

  When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates.

• preferences :: Maybe RefreshPreferences

  Set of preferences associated with the instance refresh request. If not provided, the default values are used.

• strategy :: Maybe RefreshStrategy

  The strategy to use for the instance refresh. The only valid value is Rolling.

  A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

• autoScalingGroupName :: Text

  The name of the Auto Scaling group.

Instances

ToHeaders StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

toHeaders :: StartInstanceRefresh -> [Header]

ToPath StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

toPath :: StartInstanceRefresh -> ByteString

ToQuery StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

toQuery :: StartInstanceRefresh -> QueryString

AWSRequest StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Associated Types

type AWSResponse StartInstanceRefresh

Methods

request :: (Service -> Service) -> StartInstanceRefresh -> Request StartInstanceRefresh

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartInstanceRefresh -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartInstanceRefresh)))

Generic StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Associated Types

type Rep StartInstanceRefresh :: Type -> Type

Methods

from :: StartInstanceRefresh -> Rep StartInstanceRefresh x

to :: Rep StartInstanceRefresh x -> StartInstanceRefresh

Read StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

readsPrec :: Int -> ReadS StartInstanceRefresh

readList :: ReadS [StartInstanceRefresh]

readPrec :: ReadPrec StartInstanceRefresh

readListPrec :: ReadPrec [StartInstanceRefresh]

Show StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

showsPrec :: Int -> StartInstanceRefresh -> ShowS

show :: StartInstanceRefresh -> String

showList :: [StartInstanceRefresh] -> ShowS

NFData StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

rnf :: StartInstanceRefresh -> ()

Eq StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

(==) :: StartInstanceRefresh -> StartInstanceRefresh -> Bool

(/=) :: StartInstanceRefresh -> StartInstanceRefresh -> Bool

Hashable StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

hashWithSalt :: Int -> StartInstanceRefresh -> Int

hash :: StartInstanceRefresh -> Int

type AWSResponse StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

type AWSResponse StartInstanceRefresh = StartInstanceRefreshResponse

type Rep StartInstanceRefresh

Defined in Amazonka.AutoScaling.StartInstanceRefresh

type Rep StartInstanceRefresh = D1 ('MetaData "StartInstanceRefresh" "Amazonka.AutoScaling.StartInstanceRefresh" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "StartInstanceRefresh'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "desiredConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DesiredConfiguration)) :*: S1 ('MetaSel ('Just "preferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RefreshPreferences))) :*: (S1 ('MetaSel ('Just "strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RefreshStrategy)) :*: S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartInstanceRefresh

Arguments

:: Text

StartInstanceRefresh

-> StartInstanceRefresh

Create a value of StartInstanceRefresh with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartInstanceRefresh, startInstanceRefresh_desiredConfiguration - The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates.

StartInstanceRefresh, startInstanceRefresh_preferences - Set of preferences associated with the instance refresh request. If not provided, the default values are used.

$sel:strategy:StartInstanceRefresh', startInstanceRefresh_strategy - The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

StartInstanceRefresh, startInstanceRefresh_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

startInstanceRefresh_desiredConfiguration :: Lens' StartInstanceRefresh (Maybe DesiredConfiguration)

The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates.

startInstanceRefresh_preferences :: Lens' StartInstanceRefresh (Maybe RefreshPreferences)

Set of preferences associated with the instance refresh request. If not provided, the default values are used.

startInstanceRefresh_strategy :: Lens' StartInstanceRefresh (Maybe RefreshStrategy)

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

startInstanceRefresh_autoScalingGroupName :: Lens' StartInstanceRefresh Text

The name of the Auto Scaling group.

Destructuring the Response

data StartInstanceRefreshResponse

See: newStartInstanceRefreshResponse smart constructor.

Constructors

StartInstanceRefreshResponse'

Fields

• instanceRefreshId :: Maybe Text

  A unique ID for tracking the progress of the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Associated Types

type Rep StartInstanceRefreshResponse :: Type -> Type

Methods

from :: StartInstanceRefreshResponse -> Rep StartInstanceRefreshResponse x

to :: Rep StartInstanceRefreshResponse x -> StartInstanceRefreshResponse

Read StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

readsPrec :: Int -> ReadS StartInstanceRefreshResponse

readList :: ReadS [StartInstanceRefreshResponse]

readPrec :: ReadPrec StartInstanceRefreshResponse

readListPrec :: ReadPrec [StartInstanceRefreshResponse]

Show StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

showsPrec :: Int -> StartInstanceRefreshResponse -> ShowS

show :: StartInstanceRefreshResponse -> String

showList :: [StartInstanceRefreshResponse] -> ShowS

NFData StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

rnf :: StartInstanceRefreshResponse -> ()

Eq StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

Methods

(==) :: StartInstanceRefreshResponse -> StartInstanceRefreshResponse -> Bool

(/=) :: StartInstanceRefreshResponse -> StartInstanceRefreshResponse -> Bool

type Rep StartInstanceRefreshResponse

Defined in Amazonka.AutoScaling.StartInstanceRefresh

type Rep StartInstanceRefreshResponse = D1 ('MetaData "StartInstanceRefreshResponse" "Amazonka.AutoScaling.StartInstanceRefresh" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "StartInstanceRefreshResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceRefreshId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartInstanceRefreshResponse

Arguments

:: Int

$sel:httpStatus:StartInstanceRefreshResponse'

-> StartInstanceRefreshResponse

Create a value of StartInstanceRefreshResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartInstanceRefreshResponse, startInstanceRefreshResponse_instanceRefreshId - A unique ID for tracking the progress of the request.

$sel:httpStatus:StartInstanceRefreshResponse', startInstanceRefreshResponse_httpStatus - The response's http status code.

Response Lenses

startInstanceRefreshResponse_instanceRefreshId :: Lens' StartInstanceRefreshResponse (Maybe Text)

A unique ID for tracking the progress of the request.

startInstanceRefreshResponse_httpStatus :: Lens' StartInstanceRefreshResponse Int

The response's http status code.