Class: Aws::AppConfig::Types::StartDeploymentRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppConfig::Types::StartDeploymentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appconfig/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:dynamic_extension_parameters]

Instance Attribute Summary

• #application_id ⇒ String

  The application ID.

• #configuration_profile_id ⇒ String

  The configuration profile ID.

• #configuration_version ⇒ String

  The configuration version to deploy.

• #deployment_strategy_id ⇒ String

  The deployment strategy ID.

• #description ⇒ String

  A description of the deployment.

• #dynamic_extension_parameters ⇒ Hash<String,String>

  A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

• #environment_id ⇒ String

  The environment ID.

• #kms_key_identifier ⇒ String

  The KMS key identifier (key ID, key alias, or key ARN).

• #latest_deployment_number ⇒ Integer

  The number of the latest deployment.

• #tags ⇒ Hash<String,String>

  Metadata to assign to the deployment.

Instance Attribute Details

#application_id ⇒ String

The application ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#configuration_profile_id ⇒ String

The configuration profile ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#configuration_version ⇒ String

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#deployment_strategy_id ⇒ String

The deployment strategy ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#description ⇒ String

A description of the deployment.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#dynamic_extension_parameters ⇒ Hash<String,String>

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#environment_id ⇒ String

The environment ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#kms_key_identifier ⇒ String

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#latest_deployment_number ⇒ Integer

The number of the latest deployment. Use this value to ensure that the deployment starts from the expected state and to prevent conflicting updates.

Returns:

• (Integer)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-appconfig/types.rb', line 3257

class StartDeploymentRequest < Struct.new(
  :application_id,
  :environment_id,
  :deployment_strategy_id,
  :configuration_profile_id,
  :configuration_version,
  :description,
  :tags,
  :kms_key_identifier,
  :dynamic_extension_parameters,
  :latest_deployment_number)
  SENSITIVE = [:dynamic_extension_parameters]
  include Aws::Structure
end