Class: Aws::Proton::Types::UpdateComponentInput

Inherits:

Struct

• Object
• Struct
• Aws::Proton::Types::UpdateComponentInput

Includes:

Structure

Defined in:

lib/aws-sdk-proton/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description, :service_spec, :template_file]

Instance Attribute Summary

• #client_token ⇒ String

  The client token for the updated component.

• #deployment_type ⇒ String

  The deployment type.

• #description ⇒ String

  An optional customer-provided description of the component.

• #name ⇒ String

  The name of the component to update.

• #service_instance_name ⇒ String

  The name of the service instance that you want to attach this component to.

• #service_name ⇒ String

  The name of the service that ‘serviceInstanceName` is associated with.

• #service_spec ⇒ String

  The service spec that you want the component to use to access service inputs.

• #template_file ⇒ String

  A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Instance Attribute Details

#client_token ⇒ String

The client token for the updated component.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#deployment_type ⇒ String

The deployment type. It defines the mode for updating a component, as follows:

: ‘NONE`

In this mode, a deployment *doesn't* occur. Only the requested
metadata parameters are updated. You can only specify
`description` in this mode.

: ‘CURRENT_VERSION`

In this mode, the component is deployed and updated with the new
`serviceSpec`, `templateSource`, and/or `type` that you provide.
Only requested parameters are updated.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#description ⇒ String

An optional customer-provided description of the component.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#name ⇒ String

The name of the component to update.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#service_instance_name ⇒ String

The name of the service instance that you want to attach this component to. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both ‘serviceInstanceName` and `serviceName` or for neither of them.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#service_name ⇒ String

The name of the service that ‘serviceInstanceName` is associated with. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both ‘serviceInstanceName` and `serviceName` or for neither of them.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#service_spec ⇒ String

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end

#template_file ⇒ String

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

<note markdown=“1”> Components support a single IaC file, even if you use Terraform as your template language.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 5932

class UpdateComponentInput < Struct.new(
  :client_token,
  :deployment_type,
  :description,
  :name,
  :service_instance_name,
  :service_name,
  :service_spec,
  :template_file)
  SENSITIVE = [:description, :service_spec, :template_file]
  include Aws::Structure
end