Class: AWSCDK::AppConfig::CfnDeploymentProps

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

Overview

Properties for defining a CfnDeployment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, configuration_profile_id:, configuration_version:, deployment_strategy_id:, environment_id:, description: nil, dynamic_extension_parameters: nil, kms_key_identifier: nil, tags: nil) ⇒ CfnDeploymentProps

Returns a new instance of CfnDeploymentProps.

Parameters:

  • 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.

  • environment_id (String) —

    The environment ID.

  • description (String, nil) (defaults to: nil) —

    A description of the deployment.

  • dynamic_extension_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::AppConfig::CfnDeployment::DynamicExtensionParametersProperty>, nil) (defaults to: nil) —

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

  • kms_key_identifier (String, nil) (defaults to: nil) —

    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Metadata to assign to the deployment.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app_config/cfn_deployment_props.rb', line 18

def initialize(application_id:, configuration_profile_id:, configuration_version:, deployment_strategy_id:, environment_id:, description: nil, dynamic_extension_parameters: nil, kms_key_identifier: nil, tags: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @configuration_profile_id = configuration_profile_id
  Jsii::Type.check_type(@configuration_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationProfileId")
  @configuration_version = configuration_version
  Jsii::Type.check_type(@configuration_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationVersion")
  @deployment_strategy_id = deployment_strategy_id
  Jsii::Type.check_type(@deployment_strategy_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentStrategyId")
  @environment_id = environment_id
  Jsii::Type.check_type(@environment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @dynamic_extension_parameters = dynamic_extension_parameters
  Jsii::Type.check_type(@dynamic_extension_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNmbkRlcGxveW1lbnQuRHluYW1pY0V4dGVuc2lvblBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dynamicExtensionParameters") unless @dynamic_extension_parameters.nil?
  @kms_key_identifier = kms_key_identifier
  Jsii::Type.check_type(@kms_key_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless @kms_key_identifier.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 (readonly)

The application ID.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'app_config/cfn_deployment_props.rb', line 43

def application_id
  @application_id
end

#configuration_profile_id ⇒ String (readonly)

The configuration profile ID.

Returns:

  • (String)

See Also:



48
49
50
 
# File 'app_config/cfn_deployment_props.rb', line 48

def configuration_profile_id
  @configuration_profile_id
end

#configuration_version ⇒ String (readonly)

The configuration version to deploy.

If deploying an AWS 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)

See Also:



55
56
57
 
# File 'app_config/cfn_deployment_props.rb', line 55

def configuration_version
  @configuration_version
end

#deployment_strategy_id ⇒ String (readonly)

The deployment strategy ID.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'app_config/cfn_deployment_props.rb', line 60

def deployment_strategy_id
  @deployment_strategy_id
end

#description ⇒ String? (readonly)

A description of the deployment.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'app_config/cfn_deployment_props.rb', line 70

def description
  @description
end

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

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

Returns:

See Also:



75
76
77
 
# File 'app_config/cfn_deployment_props.rb', line 75

def dynamic_extension_parameters
  @dynamic_extension_parameters
end

#environment_id ⇒ String (readonly)

The environment ID.

Returns:

  • (String)

See Also:



65
66
67
 
# File 'app_config/cfn_deployment_props.rb', line 65

def environment_id
  @environment_id
end

#kms_key_identifier ⇒ String? (readonly)

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Returns:

  • (String, nil)

See Also:



80
81
82
 
# File 'app_config/cfn_deployment_props.rb', line 80

def kms_key_identifier
  @kms_key_identifier
end

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

Metadata to assign to the deployment.

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:



87
88
89
 
# File 'app_config/cfn_deployment_props.rb', line 87

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'app_config/cfn_deployment_props.rb', line 89

def self.jsii_properties
  {
    :application_id => "applicationId",
    :configuration_profile_id => "configurationProfileId",
    :configuration_version => "configurationVersion",
    :deployment_strategy_id => "deploymentStrategyId",
    :environment_id => "environmentId",
    :description => "description",
    :dynamic_extension_parameters => "dynamicExtensionParameters",
    :kms_key_identifier => "kmsKeyIdentifier",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'app_config/cfn_deployment_props.rb', line 103

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "configurationProfileId" => @configuration_profile_id,
    "configurationVersion" => @configuration_version,
    "deploymentStrategyId" => @deployment_strategy_id,
    "environmentId" => @environment_id,
    "description" => @description,
    "dynamicExtensionParameters" => @dynamic_extension_parameters,
    "kmsKeyIdentifier" => @kms_key_identifier,
    "tags" => @tags,
  })
  result.compact
end