Class: AWSCDK::AppConfig::CfnEnvironmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_config/cfn_environment_props.rb

Overview

Properties for defining a CfnEnvironment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, name:, deletion_protection_check: nil, description: nil, monitors: nil, tags: nil) ⇒ CfnEnvironmentProps

Returns a new instance of CfnEnvironmentProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'app_config/cfn_environment_props.rb', line 15

def initialize(application_id:, name:, deletion_protection_check: nil, description: nil, monitors: nil, tags: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBjb25maWcuSUFwcGxpY2F0aW9uUmVmIn1dfX0=")), "applicationId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @deletion_protection_check = deletion_protection_check
  Jsii::Type.check_type(@deletion_protection_check, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deletionProtectionCheck") unless @deletion_protection_check.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @monitors = monitors
  Jsii::Type.check_type(@monitors, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNmbkVudmlyb25tZW50Lk1vbml0b3JzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "monitors") unless @monitors.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#application_id ⇒ String, AWSCDK::Interfaces::AWSAppconfig::IApplicationRef (readonly)

The application ID.

Returns:

See Also:



34
35
36
 
# File 'app_config/cfn_environment_props.rb', line 34

def application_id
  @application_id
end

#deletion_protection_check ⇒ String? (readonly)

A parameter to configure deletion protection.

Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or GetConfiguration in the environment during the specified interval.

This parameter supports the following values:

  • BYPASS : Instructs AWS 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 AWS AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'app_config/cfn_environment_props.rb', line 52

def deletion_protection_check
  @deletion_protection_check
end

#description ⇒ String? (readonly)

A description of the environment.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'app_config/cfn_environment_props.rb', line 57

def description
  @description
end

#monitors ⇒ AWSCDK::IResolvable, ... (readonly)

Amazon CloudWatch alarms to monitor during the deployment process.

Returns:

See Also:



62
63
64
 
# File 'app_config/cfn_environment_props.rb', line 62

def monitors
  @monitors
end

#name ⇒ String (readonly)

A name for the environment.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'app_config/cfn_environment_props.rb', line 39

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Metadata to assign to the environment.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

See Also:



69
70
71
 
# File 'app_config/cfn_environment_props.rb', line 69

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
 
# File 'app_config/cfn_environment_props.rb', line 71

def self.jsii_properties
  {
    :application_id => "applicationId",
    :name => "name",
    :deletion_protection_check => "deletionProtectionCheck",
    :description => "description",
    :monitors => "monitors",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'app_config/cfn_environment_props.rb', line 82

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "name" => @name,
    "deletionProtectionCheck" => @deletion_protection_check,
    "description" => @description,
    "monitors" => @monitors,
    "tags" => @tags,
  })
  result.compact
end