Class: AWSCDK::Wisdom::CfnAssistantAssociation
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::Wisdom::CfnAssistantAssociation
- Includes:
- IInspectable, ITaggable, Interfaces::AWSWisdom::IAssistantAssociationRef
- Defined in:
- wisdom/cfn_assistant_association.rb
Overview
Specifies an association between an Connect Customer Wisdom assistant and another resource.
Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
Class Method Summary collapse
- .arn_for_assistant_association(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_assistant_association(x) ⇒ Boolean
Checks whether the given object is a CfnAssistantAssociation.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#assistant_association_ref ⇒ AWSCDK::Interfaces::AWSWisdom::AssistantAssociationReference
A reference to a AssistantAssociation resource.
-
#assistant_id ⇒ String
The identifier of the Wisdom assistant.
- #assistant_id=(value) ⇒ Object
-
#association ⇒ AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAssistantAssociation::AssociationDataProperty
The identifier of the associated resource.
- #association=(value) ⇒ Object
-
#association_type ⇒ String
The type of association.
- #association_type=(value) ⇒ Object
-
#attr_assistant_arn ⇒ String
The Amazon Resource Name (ARN) of the Wisdom assistant.
-
#attr_assistant_association_arn ⇒ String
The Amazon Resource Name (ARN) of the assistant association.
-
#attr_assistant_association_id ⇒ String
The ID of the association.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnAssistantAssociation
constructor
Create a new
AWS::Wisdom::AssistantAssociation. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The tags used to organize, track, or control access for this resource.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnAssistantAssociation
Create a new AWS::Wisdom::AssistantAssociation.
20 21 22 23 24 25 26 |
# File 'wisdom/cfn_assistant_association.rb', line 20 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAssistantAssociationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd2lzZG9tLkNmbkFzc2lzdGFudEFzc29jaWF0aW9uUHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_assistant_association(resource) ⇒ String
79 80 81 82 |
# File 'wisdom/cfn_assistant_association.rb', line 79 def self.arn_for_assistant_association(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c193aXNkb20uSUFzc2lzdGFudEFzc29jaWF0aW9uUmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_wisdom.CfnAssistantAssociation", "arnForAssistantAssociation", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
186 187 188 |
# File 'wisdom/cfn_assistant_association.rb', line 186 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_wisdom.CfnAssistantAssociation", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_assistant_association(x) ⇒ Boolean
Checks whether the given object is a CfnAssistantAssociation.
88 89 90 91 |
# File 'wisdom/cfn_assistant_association.rb', line 88 def self.is_cfn_assistant_association(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_wisdom.CfnAssistantAssociation", "isCfnAssistantAssociation", [x]) end |
.jsii_overridable_methods ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 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 |
# File 'wisdom/cfn_assistant_association.rb', line 28 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 }, :assistant_association_ref => { kind: :property, name: "assistantAssociationRef", is_optional: false }, :attr_assistant_arn => { kind: :property, name: "attrAssistantArn", is_optional: false }, :attr_assistant_association_arn => { kind: :property, name: "attrAssistantAssociationArn", is_optional: false }, :attr_assistant_association_id => { kind: :property, name: "attrAssistantAssociationId", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :assistant_id => { kind: :property, name: "assistantId", is_optional: false }, :association => { kind: :property, name: "association", is_optional: false }, :association_type => { kind: :property, name: "associationType", is_optional: false }, :tags_raw => { kind: :property, name: "tagsRaw", 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).
311 312 313 314 |
# File 'wisdom/cfn_assistant_association.rb', line 311 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.
323 324 325 326 |
# File 'wisdom/cfn_assistant_association.rb', line 323 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
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.
333 334 335 336 |
# File 'wisdom/cfn_assistant_association.rb', line 333 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.
344 345 346 347 348 |
# File 'wisdom/cfn_assistant_association.rb', line 344 def (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.
401 402 403 404 405 |
# File 'wisdom/cfn_assistant_association.rb', line 401 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.
411 412 413 414 |
# File 'wisdom/cfn_assistant_association.rb', line 411 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).
423 424 425 426 427 |
# File 'wisdom/cfn_assistant_association.rb', line 423 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 |
#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.
436 437 438 439 |
# File 'wisdom/cfn_assistant_association.rb', line 436 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:
458 459 460 461 462 463 |
# File 'wisdom/cfn_assistant_association.rb', line 458 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#assistant_association_ref ⇒ AWSCDK::Interfaces::AWSWisdom::AssistantAssociationReference
A reference to a AssistantAssociation resource.
193 194 195 |
# File 'wisdom/cfn_assistant_association.rb', line 193 def assistant_association_ref() jsii_get_property("assistantAssociationRef") end |
#assistant_id ⇒ String
The identifier of the Wisdom assistant.
228 229 230 |
# File 'wisdom/cfn_assistant_association.rb', line 228 def assistant_id() jsii_get_property("assistantId") end |
#assistant_id=(value) ⇒ Object
232 233 234 235 |
# File 'wisdom/cfn_assistant_association.rb', line 232 def assistant_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assistantId") jsii_set_property("assistantId", value) end |
#association ⇒ AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAssistantAssociation::AssociationDataProperty
The identifier of the associated resource.
240 241 242 |
# File 'wisdom/cfn_assistant_association.rb', line 240 def association() jsii_get_property("association") end |
#association=(value) ⇒ Object
244 245 246 247 248 |
# File 'wisdom/cfn_assistant_association.rb', line 244 def association=(value) value = value.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAssistantAssociation::AssociationDataProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQXNzaXN0YW50QXNzb2NpYXRpb24uQXNzb2NpYXRpb25EYXRhUHJvcGVydHkifV19fQ==")), "association") jsii_set_property("association", value) end |
#association_type ⇒ String
The type of association.
253 254 255 |
# File 'wisdom/cfn_assistant_association.rb', line 253 def association_type() jsii_get_property("associationType") end |
#association_type=(value) ⇒ Object
257 258 259 260 |
# File 'wisdom/cfn_assistant_association.rb', line 257 def association_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associationType") jsii_set_property("associationType", value) end |
#attr_assistant_arn ⇒ String
The Amazon Resource Name (ARN) of the Wisdom assistant.
200 201 202 |
# File 'wisdom/cfn_assistant_association.rb', line 200 def attr_assistant_arn() jsii_get_property("attrAssistantArn") end |
#attr_assistant_association_arn ⇒ String
The Amazon Resource Name (ARN) of the assistant association.
207 208 209 |
# File 'wisdom/cfn_assistant_association.rb', line 207 def attr_assistant_association_arn() jsii_get_property("attrAssistantAssociationArn") end |
#attr_assistant_association_id ⇒ String
The ID of the association.
214 215 216 |
# File 'wisdom/cfn_assistant_association.rb', line 214 def attr_assistant_association_id() jsii_get_property("attrAssistantAssociationId") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
139 140 141 |
# File 'wisdom/cfn_assistant_association.rb', line 139 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
144 145 146 |
# File 'wisdom/cfn_assistant_association.rb', line 144 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
467 468 469 470 |
# File 'wisdom/cfn_assistant_association.rb', line 467 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}
149 150 151 |
# File 'wisdom/cfn_assistant_association.rb', line 149 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
156 157 158 |
# File 'wisdom/cfn_assistant_association.rb', line 156 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
101 102 103 |
# File 'wisdom/cfn_assistant_association.rb', line 101 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
161 162 163 |
# File 'wisdom/cfn_assistant_association.rb', line 161 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.
480 481 482 483 484 |
# File 'wisdom/cfn_assistant_association.rb', line 480 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.
491 492 493 494 |
# File 'wisdom/cfn_assistant_association.rb', line 491 def (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.
561 562 563 564 |
# File 'wisdom/cfn_assistant_association.rb', line 561 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) 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).
113 114 115 |
# File 'wisdom/cfn_assistant_association.rb', line 113 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
96 97 98 |
# File 'wisdom/cfn_assistant_association.rb', line 96 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.
502 503 504 |
# File 'wisdom/cfn_assistant_association.rb', line 502 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.
509 510 511 |
# File 'wisdom/cfn_assistant_association.rb', line 509 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.
302 303 304 305 |
# File 'wisdom/cfn_assistant_association.rb', line 302 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 }).
132 133 134 |
# File 'wisdom/cfn_assistant_association.rb', line 132 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.
520 521 522 523 |
# File 'wisdom/cfn_assistant_association.rb', line 520 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}
527 528 529 530 |
# File 'wisdom/cfn_assistant_association.rb', line 527 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.
537 538 539 540 541 |
# File 'wisdom/cfn_assistant_association.rb', line 537 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 |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
546 547 548 |
# File 'wisdom/cfn_assistant_association.rb', line 546 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).
122 123 124 |
# File 'wisdom/cfn_assistant_association.rb', line 122 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
221 222 223 |
# File 'wisdom/cfn_assistant_association.rb', line 221 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The tags used to organize, track, or control access for this resource.
265 266 267 |
# File 'wisdom/cfn_assistant_association.rb', line 265 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
269 270 271 272 273 |
# File 'wisdom/cfn_assistant_association.rb', line 269 def (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=")), "tagsRaw") unless value.nil? jsii_set_property("tagsRaw", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
278 279 280 |
# File 'wisdom/cfn_assistant_association.rb', line 278 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
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.
169 170 171 |
# File 'wisdom/cfn_assistant_association.rb', line 169 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.
179 180 181 |
# File 'wisdom/cfn_assistant_association.rb', line 179 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
552 553 554 555 |
# File 'wisdom/cfn_assistant_association.rb', line 552 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) 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.
291 292 293 294 295 296 |
# File 'wisdom/cfn_assistant_association.rb', line 291 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 |