Class: AWSCDK::CloudFront::CfnDistributionTenant

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCloudfront::IDistributionTenantRef
Defined in:
cloud_front/cfn_distribution_tenant.rb

Overview

The distribution tenant.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDistributionTenant

Create a new AWS::CloudFront::DistributionTenant.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::CloudFront::CfnDistributionTenantProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudFront::CfnDistributionTenantProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5DZm5EaXN0cmlidXRpb25UZW5hbnRQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_distribution_tenant(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 86

def self.arn_for_distribution_tenant(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZGZyb250LklEaXN0cmlidXRpb25UZW5hbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CfnDistributionTenant", "arnForDistributionTenant", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 193

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

.is_cfn_distribution_tenant(x) ⇒ Boolean

Checks whether the given object is a CfnDistributionTenant.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 95

def self.is_cfn_distribution_tenant(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CfnDistributionTenant", "isCfnDistributionTenant", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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 'cloud_front/cfn_distribution_tenant.rb', line 26

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_time => { kind: :property, name: "attrCreatedTime", is_optional: false },
    :attr_domain_results => { kind: :property, name: "attrDomainResults", is_optional: false },
    :attr_e_tag => { kind: :property, name: "attrETag", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :distribution_tenant_ref => { kind: :property, name: "distributionTenantRef", is_optional: false },
    :distribution_id => { kind: :property, name: "distributionId", is_optional: false },
    :domains => { kind: :property, name: "domains", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :connection_group_id => { kind: :property, name: "connectionGroupId", is_optional: true },
    :customizations => { kind: :property, name: "customizations", is_optional: true },
    :enabled => { kind: :property, name: "enabled", is_optional: true },
    :managed_certificate_request => { kind: :property, name: "managedCertificateRequest", is_optional: true },
    :parameters => { kind: :property, name: "parameters", 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).

Parameters:

  • path (String) —

    The path of the value to delete.



405
406
407
408
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 405

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:



417
418
419
420
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 417

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:



427
428
429
430
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 427

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:



438
439
440
441
442
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 438

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.


495
496
497
498
499
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 495

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.



505
506
507
508
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 505

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.



517
518
519
520
521
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 517

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.

Parameters:



530
531
532
533
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 530

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:



552
553
554
555
556
557
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 552

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_arn ⇒ String

The Amazon Resource Name (ARN) of the distribution tenant.

Returns:

  • (String) 


200
201
202
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 200

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ String

The date and time when the distribution tenant was created.

Returns:

  • (String) 


207
208
209
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 207

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_domain_results ⇒ AWSCDK::IResolvable

Returns:



212
213
214
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 212

def attr_domain_results()
  jsii_get_property("attrDomainResults")
end

#attr_e_tag ⇒ String

The current version of the distribution tenant.

Returns:

  • (String) 


219
220
221
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 219

def attr_e_tag()
  jsii_get_property("attrETag")
end

#attr_id ⇒ String

The ID of the distribution tenant.

Returns:

  • (String) 


226
227
228
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 226

def attr_id()
  jsii_get_property("attrId")
end

#attr_last_modified_time ⇒ String

The date and time when the distribution tenant was updated.

Returns:

  • (String) 


233
234
235
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 233

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#attr_status ⇒ String

The status of the distribution tenant.

Returns:

  • (String) 


240
241
242
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 240

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



247
248
249
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 247

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



146
147
148
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


561
562
563
564
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 561

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}) 


156
157
158
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connection_group_id ⇒ String?

The ID of the connection group for the distribution tenant.

Returns:

  • (String, nil) 


297
298
299
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 297

def connection_group_id()
  jsii_get_property("connectionGroupId")
end

#connection_group_id=(value) ⇒ Object 



301
302
303
304
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 301

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#customizations ⇒ AWSCDK::IResolvable, ...

Customizations for the distribution tenant.

Returns:



309
310
311
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 309

def customizations()
  jsii_get_property("customizations")
end

#customizations=(value) ⇒ Object 



313
314
315
316
317
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 313

def customizations=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFront::CfnDistributionTenant::CustomizationsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZyb250LkNmbkRpc3RyaWJ1dGlvblRlbmFudC5DdXN0b21pemF0aW9uc1Byb3BlcnR5In1dfX0=")), "customizations") unless value.nil?
  jsii_set_property("customizations", value)
end

#distribution_id ⇒ String

The ID of the multi-tenant distribution.

Returns:

  • (String) 


261
262
263
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 261

def distribution_id()
  jsii_get_property("distributionId")
end

#distribution_id=(value) ⇒ Object 



265
266
267
268
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 265

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

#distribution_tenant_ref ⇒ AWSCDK::Interfaces::AWSCloudfront::DistributionTenantReference

A reference to a DistributionTenant resource.

Returns:



254
255
256
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 254

def distribution_tenant_ref()
  jsii_get_property("distributionTenantRef")
end

#domains ⇒ Array<String>

The domains associated with the distribution tenant.

Returns:

  • (Array<String>) 


273
274
275
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 273

def domains()
  jsii_get_property("domains")
end

#domains=(value) ⇒ Object 



277
278
279
280
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 277

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

#enabled ⇒ Boolean, ...

Indicates whether the distribution tenant is in an enabled state.

Returns:



322
323
324
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 322

def enabled()
  jsii_get_property("enabled")
end

#enabled=(value) ⇒ Object 



326
327
328
329
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 326

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'cloud_front/cfn_distribution_tenant.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.

Parameters:

Returns:



574
575
576
577
578
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 574

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:



585
586
587
588
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 585

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:



655
656
657
658
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 655

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

Returns:

  • (String) 


120
121
122
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#managed_certificate_request ⇒ AWSCDK::IResolvable, ...

An object that represents the request for the Amazon CloudFront managed ACM certificate.

Returns:



334
335
336
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 334

def managed_certificate_request()
  jsii_get_property("managedCertificateRequest")
end

#managed_certificate_request=(value) ⇒ Object 



338
339
340
341
342
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 338

def managed_certificate_request=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFront::CfnDistributionTenant::ManagedCertificateRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZyb250LkNmbkRpc3RyaWJ1dGlvblRlbmFudC5NYW5hZ2VkQ2VydGlmaWNhdGVSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "managedCertificateRequest") unless value.nil?
  jsii_set_property("managedCertificateRequest", value)
end

#name ⇒ String

The name of the distribution tenant.

Returns:

  • (String) 


285
286
287
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 285

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



289
290
291
292
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 289

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) 


103
104
105
 
# File 'cloud_front/cfn_distribution_tenant.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.

Returns:



596
597
598
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 596

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:



603
604
605
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 603

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.



396
397
398
399
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 396

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

#parameters ⇒ AWSCDK::IResolvable, ...

A list of parameter values to add to the resource.

Returns:



347
348
349
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 347

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



351
352
353
354
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 351

def parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5DZm5EaXN0cmlidXRpb25UZW5hbnQuUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "parameters") unless value.nil?
  jsii_set_property("parameters", 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 }).

Returns:

  • (String) 


139
140
141
 
# File 'cloud_front/cfn_distribution_tenant.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.

Parameters:



614
615
616
617
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 614

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}) 


621
622
623
624
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 621

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:



631
632
633
634
635
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 631

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.

Returns:

  • (Boolean) —

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



640
641
642
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 640

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:



129
130
131
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 129

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A complex type that contains zero or more Tag elements.

Returns:



359
360
361
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 359

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



363
364
365
366
367
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 363

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



372
373
374
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 372

def to_string()
  jsii_call_method("toString", [])
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}) 


176
177
178
 
# File 'cloud_front/cfn_distribution_tenant.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.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


646
647
648
649
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 646

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


385
386
387
388
389
390
 
# File 'cloud_front/cfn_distribution_tenant.rb', line 385

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