Class: Aws::Proton::Types::UpdateServiceInstanceInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb

Overview

Note:

When making an API call, you may pass UpdateServiceInstanceInput data as a hash:

{
  deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
  name: "ResourceName", # required
  service_name: "ResourceName", # required
  spec: "SpecContents",
  template_major_version: "TemplateVersionPart",
  template_minor_version: "TemplateVersionPart",
}

Constant Summary collapse

SENSITIVE =
[:spec]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_typeString

The deployment type.

There are four modes for updating a service instance as described in
the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end

#nameString

The name of the service instance to update.

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end

#service_nameString

The name of the service that the service instance belongs to.

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end

#specString

The formatted specification that defines the service instance update.

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end

#template_major_versionString

The major version of the service template to update.

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end

#template_minor_versionString

The minor version of the service template to update.

Returns:

  • (String)


5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5047

class UpdateServiceInstanceInput < Struct.new(
  :deployment_type,
  :name,
  :service_name,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:spec]
  include Aws::Structure
end