Class: Aws::LaunchWizard::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb

Overview

An API client for LaunchWizard. To construct a client, you need to configure a :region and :credentials.

client = Aws::LaunchWizard::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::LaunchWizard::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::LaunchWizard::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_deployment(params = {}) ⇒ Types::CreateDeploymentOutput

Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

Examples:

Example: Deploy a given workload with given settings.


resp = client.create_deployment({
  name: "TestDeployment1", 
  deployment_pattern_name: "SapHanaSingle", 
  dry_run: false, 
  specifications: {
    "CreateSecurityGroup" => "No", 
    "DisableDeploymentRollback" => "Yes", 
    "EnableEbsVolumeEncryption" => "Yes", 
    "KeyPairName" => "keyName", 
    "ProxyServerAddress" => "http://xyz.abc.com:8080", 
    "SapSysGroupId" => "5003", 
    "SapVirtualIPOptIn" => "No", 
    "SaveDeploymentArtifacts" => "No", 
    "SnsTopicArn" => "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo", 
    "Timezone" => "Pacific/Wake", 
    "VpcId" => "vpc-1234566", 
  }, 
  workload_name: "SAP", 
})

resp.to_h outputs the following:
{
  deployment_id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
}

Example: Deploy a given workload with given settings and passing tags for Launch Wizard deployment resource.


resp = client.create_deployment({
  name: "TestDeployment2", 
  deployment_pattern_name: "SapHanaSingle", 
  dry_run: false, 
  specifications: {
    "CreateSecurityGroup" => "No", 
    "DisableDeploymentRollback" => "Yes", 
    "EnableEbsVolumeEncryption" => "Yes", 
    "KeyPairName" => "keyName", 
    "ProxyServerAddress" => "http://xyz.abc.com:8080", 
    "SapSysGroupId" => "5003", 
    "SapVirtualIPOptIn" => "No", 
    "SaveDeploymentArtifacts" => "No", 
    "SnsTopicArn" => "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo", 
    "Timezone" => "Pacific/Wake", 
    "VpcId" => "vpc-1234566", 
  }, 
  tags: {
    "key1" => "val1", 
    "key2" => "val2", 
  }, 
  workload_name: "SAP", 
})

resp.to_h outputs the following:
{
  deployment_id: "1111111-1111-1111-1111-111111111111", 
}

Request syntax with placeholder values


resp = client.create_deployment({
  workload_name: "WorkloadName", # required
  deployment_pattern_name: "DeploymentPatternName", # required
  name: "DeploymentName", # required
  specifications: { # required
    "KeyString" => "ValueString",
  },
  dry_run: false,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.deployment_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

  • :deployment_pattern_name (required, String) —

    The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

  • :name (required, String) —

    The name of the deployment.

  • :specifications (required, Hash<String,String>) —

    The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (Hash<String,String>) —

    The tags to add to the deployment.

Returns:

See Also:



610
611
612
613
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 610

def create_deployment(params = {}, options = {})
  req = build_request(:create_deployment, params)
  req.send_request(options)
end

#delete_deployment(params = {}) ⇒ Types::DeleteDeploymentOutput

Deletes a deployment.

Examples:

Example: Delete a deployment.


resp = client.delete_deployment({
  deployment_id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
})

resp.to_h outputs the following:
{
  status: "DELETED", 
  status_reason: "Finished processing DeleteApp request", 
}

Request syntax with placeholder values


resp = client.delete_deployment({
  deployment_id: "DeploymentId", # required
})

Response structure


resp.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETED", "UPDATE_FAILED", "UPDATE_ROLLBACK_COMPLETED", "UPDATE_ROLLBACK_FAILED"
resp.status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_id (required, String) —

    The ID of the deployment.

Returns:

See Also:



653
654
655
656
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 653

def delete_deployment(params = {}, options = {})
  req = build_request(:delete_deployment, params)
  req.send_request(options)
end

#get_deployment(params = {}) ⇒ Types::GetDeploymentOutput

Returns information about the deployment.

Examples:

Example: Get details about a given deployment.


resp = client.get_deployment({
  deployment_id: "1111111-1111-1111-1111-111111111111", 
})

resp.to_h outputs the following:
{
  deployment: {
    name: "SapHanaSingleForTest", 
    created_at: Time.parse("2023-04-24T13:10:09.857Z"), 
    deployment_arn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/1111111-1111-1111-1111-111111111111", 
    id: "1111111-1111-1111-1111-111111111111", 
    specifications: {
      "DisableDeploymentRollback" => "true", 
      "Encryption" => "Yes", 
      "KeyName" => "testLinuxInstance", 
      "SAPTZ" => "America/Vancouver", 
      "VPCID" => "vpc-1234567", 
      "applicationName" => "SapHanaSingleForTest", 
      "deploymentScenario" => "SapHanaSingle", 
      "environmentType" => "production", 
      "saveArtifactsS3Uri" => "s3://testbucket", 
      "saveDeploymentArtifacts" => "Yes", 
    }, 
    status: "FAILED", 
    tags: {
      "key1" => "val1", 
      "key2" => "val2", 
    }, 
    workload_name: "SapHanaSingle", 
  }, 
}

Request syntax with placeholder values


resp = client.get_deployment({
  deployment_id: "DeploymentId", # required
})

Response structure


resp.deployment.name #=> String
resp.deployment.id #=> String
resp.deployment.workload_name #=> String
resp.deployment.pattern_name #=> String
resp.deployment.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETED", "UPDATE_FAILED", "UPDATE_ROLLBACK_COMPLETED", "UPDATE_ROLLBACK_FAILED"
resp.deployment.created_at #=> Time
resp.deployment.modified_at #=> Time
resp.deployment.specifications #=> Hash
resp.deployment.specifications["KeyString"] #=> String
resp.deployment.resource_group #=> String
resp.deployment.deleted_at #=> Time
resp.deployment.tags #=> Hash
resp.deployment.tags["TagKey"] #=> String
resp.deployment.deployment_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_id (required, String) —

    The ID of the deployment.

Returns:

See Also:



729
730
731
732
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 729

def get_deployment(params = {}, options = {})
  req = build_request(:get_deployment, params)
  req.send_request(options)
end

#get_deployment_pattern_version(params = {}) ⇒ Types::GetDeploymentPatternVersionOutput

Returns information about a deployment pattern version.

Examples:

Request syntax with placeholder values


resp = client.get_deployment_pattern_version({
  workload_name: "WorkloadName", # required
  deployment_pattern_name: "DeploymentPatternName", # required
  deployment_pattern_version_name: "DeploymentPatternVersionName", # required
})

Response structure


resp.deployment_pattern_version.deployment_pattern_version_name #=> String
resp.deployment_pattern_version.description #=> String
resp.deployment_pattern_version.documentation_url #=> String
resp.deployment_pattern_version.workload_name #=> String
resp.deployment_pattern_version.deployment_pattern_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

  • :deployment_pattern_name (required, String) —

    The name of the deployment pattern. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

  • :deployment_pattern_version_name (required, String) —

    The name of the deployment pattern version.

Returns:

See Also:



780
781
782
783
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 780

def get_deployment_pattern_version(params = {}, options = {})
  req = build_request(:get_deployment_pattern_version, params)
  req.send_request(options)
end

#get_workload(params = {}) ⇒ Types::GetWorkloadOutput

Returns information about a workload.

Examples:

Example: Get details about a specific workload.


resp = client.get_workload({
  workload_name: "SAP", 
})

resp.to_h outputs the following:
{
  workload: {
    documentation_url: "https://docs.aws.amazon.com/launchwizard/latest/userguide/launch-wizard-sap.html", 
    description: "Workload Description", 
    display_name: "SAP", 
    icon_url: "https://aws-lw-workload-assets-test-us-east-1.s3.amazonaws.com/amazon/SAP/icon.png?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAUaCXVzLWVhc3QtMSJHMEUCIC4l3GCH4o%2Bgq3pJzcD1YJmtrmyNCoEgG2RIayjDWf9kAiEAnMK5nYixaZLuF1s1UVoNd7xIbDrOQ8EAbhcZWexMp9cq7wIIrf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAEGgw1ODI1NTgxMjEyMDYiDHxMN%2BZ8CoPORzvo4yrDAtkVZlBVxLwnFmwHw005vo13LOUUbyajEpp3HNh%2BaBL8K2DLx7Kzi0UPPD6z8pL1eiFLHAQ9zZgVc7pLVQjBKOdcw1GmIADDepqYEb%2B8zLi7zwWP1JT72YbT6ZXSoWpb5NCqcyAvdK47b0Ae586s6VkWzoeJ65jR%2FgbJMhRpFpqVSP2XI6Rf6yA3%2BkQyUCk3RdyF4ljIL8Nf5nIFb%2BOMK2PZ8aJX85l1j7UpJE1rfNb1PitVcQz3KlW5xkiXfcWRKeVhgHRyuCEL3FY0DyPFdqe3NxcA0%2FzPgBq6Y9B41kM6af5u2kQRfQOjWejDpzpG7w40eaIKAYnhBkjIA9550geSLB7O%2FuAPQLI9fI2lVowIBUKsKVOr0%2FFGIzW3WM7%2BbEx%2FZ0mDkP1IhcpZdP7owC77K8O%2BXDgBCabAy48K3ndi%2BQKQMPXjz6YGOp4Bbgv9mVc3sE4KvXZv1skhnOYcOKGdCncIKLne0W%2BgO3URxyDQiyO2FhM3OekXDH83CNCyDVIpkgpWkvgXDSaZiD5mj0T9iqEeJzfh6uQvX1dRN%2BxI1eV0M7HKY2e7F%2BKNjeLhzKgKpSpDqFIUSjLeBlLLyQCNKuUiO3DMiy3rB89aX4b9wyC8au0SfGb72YyNLXjh6M1whcj1VNGePyw%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230809T202649Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAYPIZLPT3GGDNTHTI%2F20230809%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6a37e41e47208b426a5e7d32392d0815388cd0231187652204836943c37ad86a", 
    status: "ACTIVE", 
    workload_name: "SAP", 
  }, 
}

Request syntax with placeholder values


resp = client.get_workload({
  workload_name: "WorkloadName", # required
})

Response structure


resp.workload.workload_name #=> String
resp.workload.display_name #=> String
resp.workload.status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
resp.workload. #=> Array
resp.workload.[0].delegated_admin.service_principal #=> String
resp.workload.description #=> String
resp.workload.documentation_url #=> String
resp.workload.icon_url #=> String
resp.workload.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload.

Returns:

See Also:



835
836
837
838
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 835

def get_workload(params = {}, options = {})
  req = build_request(:get_workload, params)
  req.send_request(options)
end

#get_workload_deployment_pattern(params = {}) ⇒ Types::GetWorkloadDeploymentPatternOutput

Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.

Examples:

Example: Get details about a specific Workload deployment pattern


resp = client.get_workload_deployment_pattern({
  deployment_pattern_name: "adSelfManagedNewVpc", 
  workload_name: "MicrosoftActiveDirectory", 
})

resp.to_h outputs the following:
{
  workload_deployment_pattern: {
    deployment_pattern_name: "adSelfManagedNewVpc", 
    deployment_pattern_version_name: "2024-03-19-14-00-09", 
    description: "Builds a new AWS environment (VPC and other components), and deploys AD DS into this new VPC.", 
    display_name: "Self-managed AD - new VPC", 
    specifications: [
      {
        name: "NumberOfAZs", 
        required: "Yes", 
        description: "Number of Availability Zones to use in the VPC.", 
      }, 
      {
        name: "AvailabilityZones", 
        required: "Yes", 
        description: "List of Availability Zones (AZs) to use for the subnets in the VPC.", 
      }, 
      {
        name: "VPCCIDR", 
        required: "Yes", 
        description: "CIDR block for the VPC.", 
      }, 
    ], 
    status: "ACTIVE", 
    workload_name: "MicrosoftActiveDirectory", 
  }, 
}

Request syntax with placeholder values


resp = client.get_workload_deployment_pattern({
  workload_name: "WorkloadName", # required
  deployment_pattern_name: "DeploymentPatternName", # required
})

Response structure


resp.workload_deployment_pattern.workload_name #=> String
resp.workload_deployment_pattern.deployment_pattern_name #=> String
resp.workload_deployment_pattern.workload_version_name #=> String
resp.workload_deployment_pattern.deployment_pattern_version_name #=> String
resp.workload_deployment_pattern.display_name #=> String
resp.workload_deployment_pattern.description #=> String
resp.workload_deployment_pattern.status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
resp.workload_deployment_pattern.status_message #=> String
resp.workload_deployment_pattern. #=> Array
resp.workload_deployment_pattern.[0].delegated_admin.service_principal #=> String
resp.workload_deployment_pattern.specifications #=> Array
resp.workload_deployment_pattern.specifications[0].name #=> String
resp.workload_deployment_pattern.specifications[0].description #=> String
resp.workload_deployment_pattern.specifications[0].allowed_values #=> Array
resp.workload_deployment_pattern.specifications[0].allowed_values[0] #=> String
resp.workload_deployment_pattern.specifications[0].required #=> String
resp.workload_deployment_pattern.specifications[0].conditionals #=> Array
resp.workload_deployment_pattern.specifications[0].conditionals[0].name #=> String
resp.workload_deployment_pattern.specifications[0].conditionals[0].value #=> String
resp.workload_deployment_pattern.specifications[0].conditionals[0].comparator #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload.

  • :deployment_pattern_name (required, String) —

    The name of the deployment pattern.

Returns:

See Also:



932
933
934
935
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 932

def get_workload_deployment_pattern(params = {}, options = {})
  req = build_request(:get_workload_deployment_pattern, params)
  req.send_request(options)
end

#list_deployment_events(params = {}) ⇒ Types::ListDeploymentEventsOutput

Lists the events of a deployment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List all actions taken during a deployment.


resp = client.list_deployment_events({
  deployment_id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
})

resp.to_h outputs the following:
{
  deployment_events: [
    {
      name: "Create secure parameter", 
      description: "Creates a new secure parameter", 
      status: "COMPLETED", 
      status_reason: "", 
      timestamp: Time.parse("2023-04-24T13:10:39.123Z"), 
    }, 
    {
      name: "Create resource group", 
      description: "Creates a resource group with all the application resources", 
      status: "COMPLETED", 
      status_reason: "", 
      timestamp: Time.parse("2023-04-24T13:10:42.238Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_deployment_events({
  deployment_id: "DeploymentId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.deployment_events #=> Array
resp.deployment_events[0].name #=> String
resp.deployment_events[0].description #=> String
resp.deployment_events[0].status #=> String, one of "CANCELED", "CANCELING", "COMPLETED", "CREATED", "FAILED", "IN_PROGRESS", "PENDING", "TIMED_OUT"
resp.deployment_events[0].status_reason #=> String
resp.deployment_events[0].timestamp #=> Time
resp.deployment_events[0].metadata #=> Hash
resp.deployment_events[0].metadata["DeploymentEventMetadataKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_id (required, String) —

    The ID of the deployment.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



1009
1010
1011
1012
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1009

def list_deployment_events(params = {}, options = {})
  req = build_request(:list_deployment_events, params)
  req.send_request(options)
end

#list_deployment_pattern_versions(params = {}) ⇒ Types::ListDeploymentPatternVersionsOutput

Lists the deployment pattern versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List all visible versions for the given workload and deployment pattern.


resp = client.list_deployment_pattern_versions({
  deployment_pattern_name: "default", 
  workload_name: "security-automations-for-aws-waf", 
})

resp.to_h outputs the following:
{
  deployment_pattern_versions: [
    {
      deployment_pattern_name: "default", 
      deployment_pattern_version_name: "4.0.6", 
      workload_name: "security-automations-for-aws-waf", 
    }, 
    {
      deployment_pattern_name: "default", 
      deployment_pattern_version_name: "3.2.5", 
      workload_name: "security-automations-for-aws-waf", 
    }, 
    {
      deployment_pattern_name: "default", 
      deployment_pattern_version_name: "3.1.0", 
      workload_name: "security-automations-for-aws-waf", 
    }, 
  ], 
}

Example: List filtered versions for the given workload and deployment pattern.


resp = client.list_deployment_pattern_versions({
  deployment_pattern_name: "default", 
  filters: [
    {
      name: "updateFromVersion", 
      values: [
        "4.0.2", 
      ], 
    }, 
  ], 
  workload_name: "security-automations-for-aws-waf", 
})

resp.to_h outputs the following:
{
  deployment_pattern_versions: [
    {
      deployment_pattern_name: "default", 
      deployment_pattern_version_name: "4.0.6", 
      workload_name: "security-automations-for-aws-waf", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_deployment_pattern_versions({
  workload_name: "WorkloadName", # required
  deployment_pattern_name: "DeploymentPatternName", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "updateFromVersion", # required, accepts updateFromVersion
      values: ["DeploymentPatternVersionFilterValuesMemberString"], # required
    },
  ],
})

Response structure


resp.deployment_pattern_versions #=> Array
resp.deployment_pattern_versions[0].deployment_pattern_version_name #=> String
resp.deployment_pattern_versions[0].description #=> String
resp.deployment_pattern_versions[0].documentation_url #=> String
resp.deployment_pattern_versions[0].workload_name #=> String
resp.deployment_pattern_versions[0].deployment_pattern_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

  • :deployment_pattern_name (required, String) —

    The name of the deployment pattern. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

  • :max_results (Integer) —

    The maximum number of deployment pattern versions to list.

  • :next_token (String) —

    The token for the next set of results.

  • :filters (Array<Types::DeploymentPatternVersionFilter>) —

    Filters to apply when listing deployment pattern versions.

Returns:

See Also:



1133
1134
1135
1136
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1133

def list_deployment_pattern_versions(params = {}, options = {})
  req = build_request(:list_deployment_pattern_versions, params)
  req.send_request(options)
end

#list_deployments(params = {}) ⇒ Types::ListDeploymentsOutput

Lists the deployments that have been created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List deployments in the account with filters.


resp = client.list_deployments({
  filters: [
    {
      name: "DEPLOYMENT_STATUS", 
      values: [
        "IN_PROGRESS", 
      ], 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  deployments: [
    {
      name: "SapHanaSingleForTest", 
      created_at: Time.parse("2023-04-24T13:10:09.857Z"), 
      id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
      pattern_name: "SapHanaSingle", 
      status: "IN_PROGRESS", 
      workload_name: "SAP", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_deployments({
  filters: [
    {
      name: "WORKLOAD_NAME", # accepts WORKLOAD_NAME, DEPLOYMENT_STATUS
      values: ["DeploymentFilterValuesMemberString"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.deployments #=> Array
resp.deployments[0].name #=> String
resp.deployments[0].id #=> String
resp.deployments[0].workload_name #=> String
resp.deployments[0].pattern_name #=> String
resp.deployments[0].status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETED", "UPDATE_FAILED", "UPDATE_ROLLBACK_COMPLETED", "UPDATE_ROLLBACK_FAILED"
resp.deployments[0].created_at #=> Time
resp.deployments[0].modified_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::DeploymentFilter>) —

    Filters to scope the results. The following filters are supported:

    • WORKLOAD_NAME - The name used in deployments.

    • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



1222
1223
1224
1225
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1222

def list_deployments(params = {}, options = {})
  req = build_request(:list_deployments, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags associated with a specified resource.

Examples:

Example: Listing tags on a Launch Wizard deployment resource.


resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", 
})

resp.to_h outputs the following:
{
  tags: {
    "key1" => "value1", 
    "key2" => "value2", 
  }, 
}

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1266
1267
1268
1269
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1266

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_workload_deployment_patterns(params = {}) ⇒ Types::ListWorkloadDeploymentPatternsOutput

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List all available workloads supported by AWS Launch Wizard.


resp = client.list_workload_deployment_patterns({
  workload_name: "SAP", 
})

resp.to_h outputs the following:
{
  workload_deployment_patterns: [
    {
      deployment_pattern_name: "SapHanaHA", 
      deployment_pattern_version_name: "2023-08-02-01-00-00", 
      description: "Deployment Option Description", 
      display_name: "Deployment Option Display Name", 
      status: "ACTIVE", 
      workload_name: "SAP", 
    }, 
    {
      deployment_pattern_name: "SapHanaMulti", 
      deployment_pattern_version_name: "2023-08-02-01-00-00", 
      description: "Deployment Option Description", 
      display_name: "Deployment Option Display Name", 
      status: "ACTIVE", 
      workload_name: "SAP", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_workload_deployment_patterns({
  workload_name: "WorkloadName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.workload_deployment_patterns #=> Array
resp.workload_deployment_patterns[0].workload_name #=> String
resp.workload_deployment_patterns[0].deployment_pattern_name #=> String
resp.workload_deployment_patterns[0].workload_version_name #=> String
resp.workload_deployment_patterns[0].deployment_pattern_version_name #=> String
resp.workload_deployment_patterns[0].display_name #=> String
resp.workload_deployment_patterns[0].description #=> String
resp.workload_deployment_patterns[0].status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
resp.workload_deployment_patterns[0].status_message #=> String
resp.workload_deployment_patterns[0]. #=> Array
resp.workload_deployment_patterns[0].[0].delegated_admin.service_principal #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workload_name (required, String) —

    The name of the workload.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



1354
1355
1356
1357
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1354

def list_workload_deployment_patterns(params = {}, options = {})
  req = build_request(:list_workload_deployment_patterns, params)
  req.send_request(options)
end

#list_workloads(params = {}) ⇒ Types::ListWorkloadsOutput

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List all available workloads supported by AWS Launch Wizard.


resp = client.list_workloads({
})

resp.to_h outputs the following:
{
  workloads: [
    {
      display_name: "SAP", 
      status: "ACTIVE", 
      workload_name: "SAP", 
    }, 
    {
      display_name: "MS SQL Server", 
      status: "ACTIVE", 
      workload_name: "SQL", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_workloads({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.workloads #=> Array
resp.workloads[0].workload_name #=> String
resp.workloads[0].display_name #=> String
resp.workloads[0].status #=> String, one of "ACTIVE", "INACTIVE", "DISABLED", "DELETED"
resp.workloads[0]. #=> Array
resp.workloads[0].[0].delegated_admin.service_principal #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



1426
1427
1428
1429
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1426

def list_workloads(params = {}, options = {})
  req = build_request(:list_workloads, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the given resource.

Examples:

Example: Adding tags to a Launch Wizard deployment resource.


resp = client.tag_resource({
  resource_arn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", 
  tags: {
    "key1" => "value1", 
    "key2" => "value2", 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    One or more tags to attach to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1469
1470
1471
1472
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1469

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the given resource.

Examples:

Example: Removing tags on a Launch Wizard deployment resource.


resp = client.untag_resource({
  resource_arn: "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", 
  tag_keys: [
    "key1", 
    "key2", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    Keys identifying the tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1510
1511
1512
1513
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1510

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_deployment(params = {}) ⇒ Types::UpdateDeploymentOutput

Updates a deployment.

Examples:

Example: Edit deployment specifications.


resp = client.update_deployment({
  deployment_id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
  dry_run: false, 
  specifications: {
    "CreateSecurityGroup" => "No", 
    "DeploymentArtifactsS3Uri" => "aws-bucket-name", 
    "DisableDeploymentRollback" => "No", 
    "EnableEbsVolumeEncryption" => "No", 
    "KeyPairName" => "keyName", 
    "ProxyServerAddress" => "http://mno.abc.com:8080", 
    "SapSysGroupId" => "5003", 
    "SapVirtualIPOptIn" => "No", 
    "SaveDeploymentArtifacts" => "Yes", 
    "SnsTopicArn" => "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo", 
    "Timezone" => "Pacific/Wake", 
    "VpcId" => "vpc-1234567", 
  }, 
})

resp.to_h outputs the following:
{
  deployment: {
    name: "TestDeployment1", 
    created_at: Time.parse(1736286728468), 
    id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
    pattern_name: "SapHanaSingle", 
    status: "UPDATE_IN_PROGRESS", 
    workload_name: "SAP", 
  }, 
}

Example: Update deployment version.


resp = client.update_deployment({
  deployment_id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
  deployment_pattern_version_name: "2.0.0", 
  dry_run: false, 
  specifications: {
    "CreateSecurityGroup" => "No", 
    "DeploymentArtifactsS3Uri" => "aws-bucket-name", 
    "DisableDeploymentRollback" => "No", 
    "EnableEbsVolumeEncryption" => "No", 
    "KeyPairName" => "keyName", 
    "NewParameter" => "Allow", 
    "ProxyServerAddress" => "http://mno.abc.com:8080", 
    "SapSysGroupId" => "5003", 
    "SapVirtualIPOptIn" => "No", 
    "SaveDeploymentArtifacts" => "Yes", 
    "SnsTopicArn" => "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo", 
    "Timezone" => "Pacific/Wake", 
    "VpcId" => "vpc-1234567", 
  }, 
})

resp.to_h outputs the following:
{
  deployment: {
    name: "TestDeployment1", 
    created_at: Time.parse(1736286728468), 
    id: "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", 
    pattern_name: "SapHanaSingle", 
    status: "UPDATE_IN_PROGRESS", 
    workload_name: "SAP", 
  }, 
}

Request syntax with placeholder values


resp = client.update_deployment({
  deployment_id: "DeploymentId", # required
  specifications: { # required
    "KeyString" => "ValueString",
  },
  workload_version_name: "WorkloadVersionName",
  deployment_pattern_version_name: "DeploymentPatternVersionName",
  dry_run: false,
  force: false,
})

Response structure


resp.deployment.name #=> String
resp.deployment.id #=> String
resp.deployment.workload_name #=> String
resp.deployment.pattern_name #=> String
resp.deployment.status #=> String, one of "COMPLETED", "CREATING", "DELETE_IN_PROGRESS", "DELETE_INITIATING", "DELETE_FAILED", "DELETED", "FAILED", "IN_PROGRESS", "VALIDATING", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETED", "UPDATE_FAILED", "UPDATE_ROLLBACK_COMPLETED", "UPDATE_ROLLBACK_FAILED"
resp.deployment.created_at #=> Time
resp.deployment.modified_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_id (required, String) —

    The ID of the deployment.

  • :specifications (required, Hash<String,String>) —

    The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

  • :workload_version_name (String) —

    The name of the workload version.

  • :deployment_pattern_version_name (String) —

    The name of the deployment pattern version.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :force (Boolean) —

    Forces the update even if validation warnings are present.

Returns:

See Also:



1649
1650
1651
1652
 
# File 'gems/aws-sdk-launchwizard/lib/aws-sdk-launchwizard/client.rb', line 1649

def update_deployment(params = {}, options = {})
  req = build_request(:update_deployment, params)
  req.send_request(options)
end