Class: AWSCDK::AppConfig::CfnConfigurationProfile

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSAppconfig::IConfigurationProfileRef
Defined in:
app_config/cfn_configuration_profile.rb

Overview

The AWS::AppConfig::ConfigurationProfile resource creates a configuration profile that enables AWS AppConfig to access the configuration source.

Valid configuration sources include AWS Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 . A configuration profile includes the following information.

  • The Uri location of the configuration data.
  • The AWS Identity and Access Management ( IAM ) role that provides access to the configuration data.
  • A validator for the configuration data. Available validators include either a JSON Schema or the Amazon Resource Name (ARN) of an AWS Lambda function.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

  • Create an application
  • Create an environment
  • Create a configuration profile
  • Choose a pre-defined deployment strategy or create your own
  • Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConfigurationProfile

Create a new AWS::AppConfig::ConfigurationProfile.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::AppConfig::CfnConfigurationProfileProps) —

    Resource properties.



34
35
36
37
38
39
40
 
# File 'app_config/cfn_configuration_profile.rb', line 34

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppConfig::CfnConfigurationProfileProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNmbkNvbmZpZ3VyYXRpb25Qcm9maWxlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'app_config/cfn_configuration_profile.rb', line 198

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appconfig.CfnConfigurationProfile", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_configuration_profile(x) ⇒ Boolean

Checks whether the given object is a CfnConfigurationProfile.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'app_config/cfn_configuration_profile.rb', line 100

def self.is_cfn_configuration_profile(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.CfnConfigurationProfile", "isCfnConfigurationProfile", [x])
end

.jsii_overridable_methods ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app_config/cfn_configuration_profile.rb', line 42

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_configuration_profile_id => { kind: :property, name: "attrConfigurationProfileId", is_optional: false },
    :attr_kms_key_arn => { kind: :property, name: "attrKmsKeyArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :configuration_profile_ref => { kind: :property, name: "configurationProfileRef", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :location_uri => { kind: :property, name: "locationUri", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :deletion_protection_check => { kind: :property, name: "deletionProtectionCheck", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :kms_key_identifier => { kind: :property, name: "kmsKeyIdentifier", is_optional: true },
    :retrieval_role_arn => { kind: :property, name: "retrievalRoleArn", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :validators => { kind: :property, name: "validators", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



391
392
393
394
 
# File 'app_config/cfn_configuration_profile.rb', line 391

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



403
404
405
406
 
# File 'app_config/cfn_configuration_profile.rb', line 403

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



413
414
415
416
 
# File 'app_config/cfn_configuration_profile.rb', line 413

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



424
425
426
427
428
 
# File 'app_config/cfn_configuration_profile.rb', line 424

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


481
482
483
484
485
 
# File 'app_config/cfn_configuration_profile.rb', line 481

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



491
492
493
494
 
# File 'app_config/cfn_configuration_profile.rb', line 491

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



503
504
505
506
507
 
# File 'app_config/cfn_configuration_profile.rb', line 503

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#application_id ⇒ String

The application ID.

Returns:

  • (String) 


235
236
237
 
# File 'app_config/cfn_configuration_profile.rb', line 235

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



239
240
241
242
 
# File 'app_config/cfn_configuration_profile.rb', line 239

def application_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  jsii_set_property("applicationId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



516
517
518
519
 
# File 'app_config/cfn_configuration_profile.rb', line 516

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



538
539
540
541
542
543
 
# File 'app_config/cfn_configuration_profile.rb', line 538

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_configuration_profile_id ⇒ String

The configuration profile ID.

Returns:

  • (String) 


205
206
207
 
# File 'app_config/cfn_configuration_profile.rb', line 205

def attr_configuration_profile_id()
  jsii_get_property("attrConfigurationProfileId")
end

#attr_kms_key_arn ⇒ String

The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store.

This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS key for that particular service.

Returns:

  • (String) 


214
215
216
 
# File 'app_config/cfn_configuration_profile.rb', line 214

def attr_kms_key_arn()
  jsii_get_property("attrKmsKeyArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



221
222
223
 
# File 'app_config/cfn_configuration_profile.rb', line 221

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



151
152
153
 
# File 'app_config/cfn_configuration_profile.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'app_config/cfn_configuration_profile.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


547
548
549
550
 
# File 'app_config/cfn_configuration_profile.rb', line 547

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


161
162
163
 
# File 'app_config/cfn_configuration_profile.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'app_config/cfn_configuration_profile.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_profile_ref ⇒ AWSCDK::Interfaces::AWSAppconfig::ConfigurationProfileReference

A reference to a ConfigurationProfile resource.

Returns:



228
229
230
 
# File 'app_config/cfn_configuration_profile.rb', line 228

def configuration_profile_ref()
  jsii_get_property("configurationProfileRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'app_config/cfn_configuration_profile.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection_check ⇒ String?

A parameter to configure deletion protection.

Returns:

  • (String, nil) 


273
274
275
 
# File 'app_config/cfn_configuration_profile.rb', line 273

def deletion_protection_check()
  jsii_get_property("deletionProtectionCheck")
end

#deletion_protection_check=(value) ⇒ Object 



277
278
279
280
 
# File 'app_config/cfn_configuration_profile.rb', line 277

def deletion_protection_check=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deletionProtectionCheck") unless value.nil?
  jsii_set_property("deletionProtectionCheck", value)
end

#description ⇒ String?

A description of the configuration profile.

Returns:

  • (String, nil) 


285
286
287
 
# File 'app_config/cfn_configuration_profile.rb', line 285

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



289
290
291
292
 
# File 'app_config/cfn_configuration_profile.rb', line 289

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



173
174
175
 
# File 'app_config/cfn_configuration_profile.rb', line 173

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



560
561
562
563
564
 
# File 'app_config/cfn_configuration_profile.rb', line 560

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



571
572
573
574
 
# File 'app_config/cfn_configuration_profile.rb', line 571

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



641
642
643
644
 
# File 'app_config/cfn_configuration_profile.rb', line 641

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_identifier ⇒ String?

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) 


297
298
299
 
# File 'app_config/cfn_configuration_profile.rb', line 297

def kms_key_identifier()
  jsii_get_property("kmsKeyIdentifier")
end

#kms_key_identifier=(value) ⇒ Object 



301
302
303
304
 
# File 'app_config/cfn_configuration_profile.rb', line 301

def kms_key_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless value.nil?
  jsii_set_property("kmsKeyIdentifier", value)
end

#location_uri ⇒ String

A URI to locate the configuration.

You can specify the following:.

Returns:

  • (String) 


249
250
251
 
# File 'app_config/cfn_configuration_profile.rb', line 249

def location_uri()
  jsii_get_property("locationUri")
end

#location_uri=(value) ⇒ Object 



253
254
255
256
 
# File 'app_config/cfn_configuration_profile.rb', line 253

def location_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "locationUri")
  jsii_set_property("locationUri", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


125
126
127
 
# File 'app_config/cfn_configuration_profile.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A name for the configuration profile.

Returns:

  • (String) 


261
262
263
 
# File 'app_config/cfn_configuration_profile.rb', line 261

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



265
266
267
268
 
# File 'app_config/cfn_configuration_profile.rb', line 265

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'app_config/cfn_configuration_profile.rb', line 108

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



582
583
584
 
# File 'app_config/cfn_configuration_profile.rb', line 582

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



589
590
591
 
# File 'app_config/cfn_configuration_profile.rb', line 589

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



382
383
384
385
 
# File 'app_config/cfn_configuration_profile.rb', line 382

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


144
145
146
 
# File 'app_config/cfn_configuration_profile.rb', line 144

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



600
601
602
603
 
# File 'app_config/cfn_configuration_profile.rb', line 600

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


607
608
609
610
 
# File 'app_config/cfn_configuration_profile.rb', line 607

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



617
618
619
620
621
 
# File 'app_config/cfn_configuration_profile.rb', line 617

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#retrieval_role_arn ⇒ String?

The ARN of an IAM role with permission to access the configuration at the specified LocationUri .

Returns:

  • (String, nil) 


309
310
311
 
# File 'app_config/cfn_configuration_profile.rb', line 309

def retrieval_role_arn()
  jsii_get_property("retrievalRoleArn")
end

#retrieval_role_arn=(value) ⇒ Object 



313
314
315
316
 
# File 'app_config/cfn_configuration_profile.rb', line 313

def retrieval_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "retrievalRoleArn") unless value.nil?
  jsii_set_property("retrievalRoleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



626
627
628
 
# File 'app_config/cfn_configuration_profile.rb', line 626

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



134
135
136
 
# File 'app_config/cfn_configuration_profile.rb', line 134

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Metadata to assign to the configuration profile.

Returns:



321
322
323
 
# File 'app_config/cfn_configuration_profile.rb', line 321

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



325
326
327
328
329
 
# File 'app_config/cfn_configuration_profile.rb', line 325

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



358
359
360
 
# File 'app_config/cfn_configuration_profile.rb', line 358

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ String?

The type of configurations contained in the profile.

Returns:

  • (String, nil) 


334
335
336
 
# File 'app_config/cfn_configuration_profile.rb', line 334

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



338
339
340
341
 
# File 'app_config/cfn_configuration_profile.rb', line 338

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'app_config/cfn_configuration_profile.rb', line 181

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'app_config/cfn_configuration_profile.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


632
633
634
635
 
# File 'app_config/cfn_configuration_profile.rb', line 632

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#validators ⇒ AWSCDK::IResolvable, ...

A list of methods for validating the configuration.

Returns:



346
347
348
 
# File 'app_config/cfn_configuration_profile.rb', line 346

def validators()
  jsii_get_property("validators")
end

#validators=(value) ⇒ Object 



350
351
352
353
 
# File 'app_config/cfn_configuration_profile.rb', line 350

def validators=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNmbkNvbmZpZ3VyYXRpb25Qcm9maWxlLlZhbGlkYXRvcnNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "validators") unless value.nil?
  jsii_set_property("validators", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


371
372
373
374
375
376
 
# File 'app_config/cfn_configuration_profile.rb', line 371

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end