Class: AWSCDK::LicenseManager::CfnLicense
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::LicenseManager::CfnLicense
- Includes:
- IInspectable, ITaggableV2, Interfaces::AWSLicensemanager::ILicenseRef
- Defined in:
- license_manager/cfn_license.rb
Overview
Specifies a granted license.
Granted licenses are licenses for products that your organization purchased from AWS Marketplace or directly from a seller who integrated their software with managed entitlements. For more information, see Granted licenses in the License Manager User Guide .
Class Method Summary collapse
- .arn_for_license(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_license(x) ⇒ Boolean
Checks whether the given object is a CfnLicense.
- .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.
-
#attr_license_arn ⇒ String
The Amazon Resource Name (ARN) of the license.
-
#attr_version ⇒ String
The license version.
-
#beneficiary ⇒ String
License beneficiary.
- #beneficiary=(value) ⇒ Object
-
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#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.
-
#consumption_configuration ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::ConsumptionConfigurationProperty
Configuration for consumption of the license.
- #consumption_configuration=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
-
#entitlements ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::EntitlementProperty>
License entitlements.
- #entitlements=(value) ⇒ Object
- #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.
-
#home_region ⇒ String
Home Region of the license.
- #home_region=(value) ⇒ Object
-
#initialize(scope, id, props) ⇒ CfnLicense
constructor
Create a new
AWS::LicenseManager::License. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#issuer ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::IssuerDataProperty
License issuer.
- #issuer=(value) ⇒ Object
-
#license_metadata ⇒ AWSCDK::IResolvable, ...
License metadata.
- #license_metadata=(value) ⇒ Object
-
#license_name ⇒ String
License name.
- #license_name=(value) ⇒ Object
-
#license_ref ⇒ AWSCDK::Interfaces::AWSLicensemanager::LicenseReference
A reference to a License resource.
-
#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.
-
#product_name ⇒ String
Product name.
- #product_name=(value) ⇒ Object
-
#product_sku ⇒ String
Product SKU.
- #product_sku=(value) ⇒ Object
-
#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.
-
#status ⇒ String?
License status.
- #status=(value) ⇒ Object
-
#tags ⇒ Array<AWSCDK::CfnTag>?
A list of tags to attach.
- #tags=(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
-
#validity ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::ValidityDateFormatProperty
Date and time range during which the license is valid, in ISO8601-UTC format.
- #validity=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnLicense
Create a new AWS::LicenseManager::License.
20 21 22 23 24 25 26 |
# File 'license_manager/cfn_license.rb', line 20 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::LicenseManager::CfnLicenseProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGljZW5zZW1hbmFnZXIuQ2ZuTGljZW5zZVByb3BzIn0=")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_license(resource) ⇒ String
86 87 88 89 |
# File 'license_manager/cfn_license.rb', line 86 def self.arn_for_license(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19saWNlbnNlbWFuYWdlci5JTGljZW5zZVJlZiJ9")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_licensemanager.CfnLicense", "arnForLicense", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
193 194 195 |
# File 'license_manager/cfn_license.rb', line 193 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_licensemanager.CfnLicense", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_license(x) ⇒ Boolean
Checks whether the given object is a CfnLicense.
95 96 97 98 |
# File 'license_manager/cfn_license.rb', line 95 def self.is_cfn_license(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_licensemanager.CfnLicense", "isCfnLicense", [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 76 77 78 79 80 81 82 |
# File 'license_manager/cfn_license.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 }, :attr_license_arn => { kind: :property, name: "attrLicenseArn", is_optional: false }, :attr_version => { kind: :property, name: "attrVersion", is_optional: false }, :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false }, :license_ref => { kind: :property, name: "licenseRef", is_optional: false }, :beneficiary => { kind: :property, name: "beneficiary", is_optional: false }, :consumption_configuration => { kind: :property, name: "consumptionConfiguration", is_optional: false }, :entitlements => { kind: :property, name: "entitlements", is_optional: false }, :home_region => { kind: :property, name: "homeRegion", is_optional: false }, :issuer => { kind: :property, name: "issuer", is_optional: false }, :license_name => { kind: :property, name: "licenseName", is_optional: false }, :product_name => { kind: :property, name: "productName", is_optional: false }, :product_sku => { kind: :property, name: "productSku", is_optional: false }, :validity => { kind: :property, name: "validity", is_optional: false }, :license_metadata => { kind: :property, name: "licenseMetadata", is_optional: true }, :status => { kind: :property, name: "status", is_optional: true }, :tags => { kind: :property, name: "tags", 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).
409 410 411 412 |
# File 'license_manager/cfn_license.rb', line 409 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.
421 422 423 424 |
# File 'license_manager/cfn_license.rb', line 421 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.
431 432 433 434 |
# File 'license_manager/cfn_license.rb', line 431 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.
442 443 444 445 446 |
# File 'license_manager/cfn_license.rb', line 442 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.
499 500 501 502 503 |
# File 'license_manager/cfn_license.rb', line 499 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.
509 510 511 512 |
# File 'license_manager/cfn_license.rb', line 509 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).
521 522 523 524 525 |
# File 'license_manager/cfn_license.rb', line 521 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.
534 535 536 537 |
# File 'license_manager/cfn_license.rb', line 534 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:
556 557 558 559 560 561 |
# File 'license_manager/cfn_license.rb', line 556 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 |
#attr_license_arn ⇒ String
The Amazon Resource Name (ARN) of the license.
200 201 202 |
# File 'license_manager/cfn_license.rb', line 200 def attr_license_arn() jsii_get_property("attrLicenseArn") end |
#attr_version ⇒ String
The license version.
207 208 209 |
# File 'license_manager/cfn_license.rb', line 207 def attr_version() jsii_get_property("attrVersion") end |
#beneficiary ⇒ String
License beneficiary.
228 229 230 |
# File 'license_manager/cfn_license.rb', line 228 def beneficiary() jsii_get_property("beneficiary") end |
#beneficiary=(value) ⇒ Object
232 233 234 235 |
# File 'license_manager/cfn_license.rb', line 232 def beneficiary=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "beneficiary") jsii_set_property("beneficiary", value) end |
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
214 215 216 |
# File 'license_manager/cfn_license.rb', line 214 def cdk_tag_manager() jsii_get_property("cdkTagManager") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
146 147 148 |
# File 'license_manager/cfn_license.rb', line 146 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
151 152 153 |
# File 'license_manager/cfn_license.rb', line 151 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
565 566 567 568 |
# File 'license_manager/cfn_license.rb', line 565 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}
156 157 158 |
# File 'license_manager/cfn_license.rb', line 156 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
163 164 165 |
# File 'license_manager/cfn_license.rb', line 163 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#consumption_configuration ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::ConsumptionConfigurationProperty
Configuration for consumption of the license.
240 241 242 |
# File 'license_manager/cfn_license.rb', line 240 def consumption_configuration() jsii_get_property("consumptionConfiguration") end |
#consumption_configuration=(value) ⇒ Object
244 245 246 247 248 |
# File 'license_manager/cfn_license.rb', line 244 def consumption_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::LicenseManager::CfnLicense::ConsumptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWNlbnNlbWFuYWdlci5DZm5MaWNlbnNlLkNvbnN1bXB0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "consumptionConfiguration") jsii_set_property("consumptionConfiguration", value) end |
#creation_stack ⇒ Array<String>
108 109 110 |
# File 'license_manager/cfn_license.rb', line 108 def creation_stack() jsii_get_property("creationStack") end |
#entitlements ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::EntitlementProperty>
License entitlements.
253 254 255 |
# File 'license_manager/cfn_license.rb', line 253 def entitlements() jsii_get_property("entitlements") end |
#entitlements=(value) ⇒ Object
257 258 259 260 |
# File 'license_manager/cfn_license.rb', line 257 def entitlements=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGljZW5zZW1hbmFnZXIuQ2ZuTGljZW5zZS5FbnRpdGxlbWVudFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "entitlements") jsii_set_property("entitlements", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
168 169 170 |
# File 'license_manager/cfn_license.rb', line 168 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.
578 579 580 581 582 |
# File 'license_manager/cfn_license.rb', line 578 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.
589 590 591 592 |
# File 'license_manager/cfn_license.rb', line 589 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#home_region ⇒ String
Home Region of the license.
265 266 267 |
# File 'license_manager/cfn_license.rb', line 265 def home_region() jsii_get_property("homeRegion") end |
#home_region=(value) ⇒ Object
269 270 271 272 |
# File 'license_manager/cfn_license.rb', line 269 def home_region=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "homeRegion") jsii_set_property("homeRegion", value) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
659 660 661 662 |
# File 'license_manager/cfn_license.rb', line 659 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#issuer ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::IssuerDataProperty
License issuer.
277 278 279 |
# File 'license_manager/cfn_license.rb', line 277 def issuer() jsii_get_property("issuer") end |
#issuer=(value) ⇒ Object
281 282 283 284 285 |
# File 'license_manager/cfn_license.rb', line 281 def issuer=(value) value = value.is_a?(Hash) ? ::AWSCDK::LicenseManager::CfnLicense::IssuerDataProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWNlbnNlbWFuYWdlci5DZm5MaWNlbnNlLklzc3VlckRhdGFQcm9wZXJ0eSJ9XX19")), "issuer") jsii_set_property("issuer", value) end |
#license_metadata ⇒ AWSCDK::IResolvable, ...
License metadata.
339 340 341 |
# File 'license_manager/cfn_license.rb', line 339 def () jsii_get_property("licenseMetadata") end |
#license_metadata=(value) ⇒ Object
343 344 345 346 |
# File 'license_manager/cfn_license.rb', line 343 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGljZW5zZW1hbmFnZXIuQ2ZuTGljZW5zZS5NZXRhZGF0YVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "licenseMetadata") unless value.nil? jsii_set_property("licenseMetadata", value) end |
#license_name ⇒ String
License name.
290 291 292 |
# File 'license_manager/cfn_license.rb', line 290 def license_name() jsii_get_property("licenseName") end |
#license_name=(value) ⇒ Object
294 295 296 297 |
# File 'license_manager/cfn_license.rb', line 294 def license_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "licenseName") jsii_set_property("licenseName", value) end |
#license_ref ⇒ AWSCDK::Interfaces::AWSLicensemanager::LicenseReference
A reference to a License resource.
221 222 223 |
# File 'license_manager/cfn_license.rb', line 221 def license_ref() jsii_get_property("licenseRef") 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).
120 121 122 |
# File 'license_manager/cfn_license.rb', line 120 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
103 104 105 |
# File 'license_manager/cfn_license.rb', line 103 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.
600 601 602 |
# File 'license_manager/cfn_license.rb', line 600 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.
607 608 609 |
# File 'license_manager/cfn_license.rb', line 607 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.
400 401 402 403 |
# File 'license_manager/cfn_license.rb', line 400 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 |
#product_name ⇒ String
Product name.
302 303 304 |
# File 'license_manager/cfn_license.rb', line 302 def product_name() jsii_get_property("productName") end |
#product_name=(value) ⇒ Object
306 307 308 309 |
# File 'license_manager/cfn_license.rb', line 306 def product_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productName") jsii_set_property("productName", value) end |
#product_sku ⇒ String
Product SKU.
314 315 316 |
# File 'license_manager/cfn_license.rb', line 314 def product_sku() jsii_get_property("productSku") end |
#product_sku=(value) ⇒ Object
318 319 320 321 |
# File 'license_manager/cfn_license.rb', line 318 def product_sku=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productSku") jsii_set_property("productSku", value) 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 }).
139 140 141 |
# File 'license_manager/cfn_license.rb', line 139 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.
618 619 620 621 |
# File 'license_manager/cfn_license.rb', line 618 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}
625 626 627 628 |
# File 'license_manager/cfn_license.rb', line 625 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.
635 636 637 638 639 |
# File 'license_manager/cfn_license.rb', line 635 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.
644 645 646 |
# File 'license_manager/cfn_license.rb', line 644 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).
129 130 131 |
# File 'license_manager/cfn_license.rb', line 129 def stack() jsii_get_property("stack") end |
#status ⇒ String?
License status.
351 352 353 |
# File 'license_manager/cfn_license.rb', line 351 def status() jsii_get_property("status") end |
#status=(value) ⇒ Object
355 356 357 358 |
# File 'license_manager/cfn_license.rb', line 355 def status=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless value.nil? jsii_set_property("status", value) end |
#tags ⇒ Array<AWSCDK::CfnTag>?
A list of tags to attach.
363 364 365 |
# File 'license_manager/cfn_license.rb', line 363 def () jsii_get_property("tags") end |
#tags=(value) ⇒ Object
367 368 369 370 371 |
# File 'license_manager/cfn_license.rb', line 367 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=")), "tags") unless value.nil? jsii_set_property("tags", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
376 377 378 |
# File 'license_manager/cfn_license.rb', line 376 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.
176 177 178 |
# File 'license_manager/cfn_license.rb', line 176 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.
186 187 188 |
# File 'license_manager/cfn_license.rb', line 186 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
650 651 652 653 |
# File 'license_manager/cfn_license.rb', line 650 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#validity ⇒ AWSCDK::IResolvable, AWSCDK::LicenseManager::CfnLicense::ValidityDateFormatProperty
Date and time range during which the license is valid, in ISO8601-UTC format.
326 327 328 |
# File 'license_manager/cfn_license.rb', line 326 def validity() jsii_get_property("validity") end |
#validity=(value) ⇒ Object
330 331 332 333 334 |
# File 'license_manager/cfn_license.rb', line 330 def validity=(value) value = value.is_a?(Hash) ? ::AWSCDK::LicenseManager::CfnLicense::ValidityDateFormatProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19saWNlbnNlbWFuYWdlci5DZm5MaWNlbnNlLlZhbGlkaXR5RGF0ZUZvcm1hdFByb3BlcnR5In1dfX0=")), "validity") jsii_set_property("validity", 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.
389 390 391 392 393 394 |
# File 'license_manager/cfn_license.rb', line 389 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 |