Class: Aws::AppConfig::Types::DeleteEnvironmentRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-appconfig/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The application ID that includes the environment that you want to delete.

Returns:

  • (String) 


933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-appconfig/types.rb', line 933

class DeleteEnvironmentRequest < Struct.new(
  :environment_id,
  :application_id,
  :deletion_protection_check)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_check ⇒ String

A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting an environment if your application called either [GetLatestConfiguration] or in the environment during the specified interval.

This parameter supports the following values:

  • ‘BYPASS`: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.

  • ‘APPLY`: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. `APPLY` also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.

  • ‘ACCOUNT_DEFAULT`: The default setting, which instructs AppConfig to implement the deletion protection value specified in the `UpdateAccountSettings` API.

[1]: docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html

Returns:

  • (String) 


933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-appconfig/types.rb', line 933

class DeleteEnvironmentRequest < Struct.new(
  :environment_id,
  :application_id,
  :deletion_protection_check)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The ID of the environment that you want to delete.

Returns:

  • (String) 


933
934
935
936
937
938
939
 
# File 'lib/aws-sdk-appconfig/types.rb', line 933

class DeleteEnvironmentRequest < Struct.new(
  :environment_id,
  :application_id,
  :deletion_protection_check)
  SENSITIVE = []
  include Aws::Structure
end