Class: AWSCDK::EVS::CfnEnvironment

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEvs::IEnvironmentRef
Defined in:
evs/cfn_environment.rb

Overview

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

You cannot use the dedicated_host_id and placement_group_id parameters together in the same CreateEnvironment action. This results in a ValidationException response.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEnvironment

Create a new AWS::EVS::Environment.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EVS::CfnEnvironmentProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'evs/cfn_environment.rb', line 24

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

Class Method Details

.arn_for_environment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'evs/cfn_environment.rb', line 98

def self.arn_for_environment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ldnMuSUVudmlyb25tZW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_evs.CfnEnvironment", "arnForEnvironment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'evs/cfn_environment.rb', line 205

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

.is_cfn_environment(x) ⇒ Boolean

Checks whether the given object is a CfnEnvironment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'evs/cfn_environment.rb', line 107

def self.is_cfn_environment(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_evs.CfnEnvironment", "isCfnEnvironment", [x])
end

.jsii_overridable_methods ⇒ Object 



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
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'evs/cfn_environment.rb', line 32

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_checks => { kind: :property, name: "attrChecks", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_credentials => { kind: :property, name: "attrCredentials", is_optional: false },
    :attr_environment_arn => { kind: :property, name: "attrEnvironmentArn", is_optional: false },
    :attr_environment_id => { kind: :property, name: "attrEnvironmentId", is_optional: false },
    :attr_environment_state => { kind: :property, name: "attrEnvironmentState", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_state_details => { kind: :property, name: "attrStateDetails", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :environment_ref => { kind: :property, name: "environmentRef", is_optional: false },
    :connectivity_info => { kind: :property, name: "connectivityInfo", is_optional: false },
    :license_info => { kind: :property, name: "licenseInfo", is_optional: false },
    :service_access_subnet_id => { kind: :property, name: "serviceAccessSubnetId", is_optional: false },
    :site_id => { kind: :property, name: "siteId", is_optional: false },
    :terms_accepted => { kind: :property, name: "termsAccepted", is_optional: false },
    :vcf_hostnames => { kind: :property, name: "vcfHostnames", is_optional: false },
    :vcf_version => { kind: :property, name: "vcfVersion", is_optional: false },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: false },
    :environment_name => { kind: :property, name: "environmentName", is_optional: true },
    :hosts => { kind: :property, name: "hosts", is_optional: true },
    :initial_vlans => { kind: :property, name: "initialVlans", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :service_access_security_groups => { kind: :property, name: "serviceAccessSecurityGroups", 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.



507
508
509
510
 
# File 'evs/cfn_environment.rb', line 507

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:



519
520
521
522
 
# File 'evs/cfn_environment.rb', line 519

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:



529
530
531
532
 
# File 'evs/cfn_environment.rb', line 529

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:



540
541
542
543
544
 
# File 'evs/cfn_environment.rb', line 540

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.


597
598
599
600
601
 
# File 'evs/cfn_environment.rb', line 597

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.



607
608
609
610
 
# File 'evs/cfn_environment.rb', line 607

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.



619
620
621
622
623
 
# File 'evs/cfn_environment.rb', line 619

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:



632
633
634
635
 
# File 'evs/cfn_environment.rb', line 632

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:



654
655
656
657
658
659
 
# File 'evs/cfn_environment.rb', line 654

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_checks ⇒ AWSCDK::IResolvable

A check on the environment to identify instance health and VMware VCF licensing issues. For example:.

{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }

Returns:



214
215
216
 
# File 'evs/cfn_environment.rb', line 214

def attr_checks()
  jsii_get_property("attrChecks")
end

#attr_created_at ⇒ String

The date and time that the environment was created.

For example: 1749081600.000 .

Returns:

  • (String) 


223
224
225
 
# File 'evs/cfn_environment.rb', line 223

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_credentials ⇒ AWSCDK::IResolvable

The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager.

Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:

{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }

Returns:



234
235
236
 
# File 'evs/cfn_environment.rb', line 234

def attr_credentials()
  jsii_get_property("attrCredentials")
end

#attr_environment_arn ⇒ String

The Amazon Resource Name (ARN) that is associated with the environment.

For example: arn:aws:evs:us-east-1:000000000000:environment/env-1234567890 .

Returns:

  • (String) 


243
244
245
 
# File 'evs/cfn_environment.rb', line 243

def attr_environment_arn()
  jsii_get_property("attrEnvironmentArn")
end

#attr_environment_id ⇒ String

The unique ID for the environment.

For example: env-1234567890 .

Returns:

  • (String) 


252
253
254
 
# File 'evs/cfn_environment.rb', line 252

def attr_environment_id()
  jsii_get_property("attrEnvironmentId")
end

#attr_environment_state ⇒ String

The state of an environment.

For example: CREATED .

Returns:

  • (String) 


261
262
263
 
# File 'evs/cfn_environment.rb', line 261

def attr_environment_state()
  jsii_get_property("attrEnvironmentState")
end

#attr_modified_at ⇒ String

The date and time that the environment was modified.

For example: 1749081600.000 .

Returns:

  • (String) 


270
271
272
 
# File 'evs/cfn_environment.rb', line 270

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_state_details ⇒ String

A detailed description of the environmentState of an environment.

For example: Environment successfully created .

Returns:

  • (String) 


279
280
281
 
# File 'evs/cfn_environment.rb', line 279

def attr_state_details()
  jsii_get_property("attrStateDetails")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



286
287
288
 
# File 'evs/cfn_environment.rb', line 286

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'evs/cfn_environment.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'evs/cfn_environment.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


663
664
665
666
 
# File 'evs/cfn_environment.rb', line 663

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


168
169
170
 
# File 'evs/cfn_environment.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'evs/cfn_environment.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connectivity_info ⇒ AWSCDK::IResolvable, AWSCDK::EVS::CfnEnvironment::ConnectivityInfoProperty

The connectivity configuration for the environment.

Returns:



300
301
302
 
# File 'evs/cfn_environment.rb', line 300

def connectivity_info()
  jsii_get_property("connectivityInfo")
end

#connectivity_info=(value) ⇒ Object 



304
305
306
307
308
 
# File 'evs/cfn_environment.rb', line 304

def connectivity_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EVS::CfnEnvironment::ConnectivityInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldnMuQ2ZuRW52aXJvbm1lbnQuQ29ubmVjdGl2aXR5SW5mb1Byb3BlcnR5In1dfX0=")), "connectivityInfo")
  jsii_set_property("connectivityInfo", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'evs/cfn_environment.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'evs/cfn_environment.rb', line 180

def env()
  jsii_get_property("env")
end

#environment_name ⇒ String?

The name of the environment.

Returns:

  • (String, nil) 


399
400
401
 
# File 'evs/cfn_environment.rb', line 399

def environment_name()
  jsii_get_property("environmentName")
end

#environment_name=(value) ⇒ Object 



403
404
405
406
 
# File 'evs/cfn_environment.rb', line 403

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

#environment_ref ⇒ AWSCDK::Interfaces::AWSEvs::EnvironmentReference

A reference to a Environment resource.

Returns:



293
294
295
 
# File 'evs/cfn_environment.rb', line 293

def environment_ref()
  jsii_get_property("environmentRef")
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:



676
677
678
679
680
 
# File 'evs/cfn_environment.rb', line 676

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:



687
688
689
690
 
# File 'evs/cfn_environment.rb', line 687

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

#hosts ⇒ AWSCDK::IResolvable, ...

Required for environment resource creation.

Returns:



411
412
413
 
# File 'evs/cfn_environment.rb', line 411

def hosts()
  jsii_get_property("hosts")
end

#hosts=(value) ⇒ Object 



415
416
417
418
 
# File 'evs/cfn_environment.rb', line 415

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

#initial_vlans ⇒ AWSCDK::IResolvable, ...

Amazon EVS is in public preview release and is subject to change.

Returns:



423
424
425
 
# File 'evs/cfn_environment.rb', line 423

def initial_vlans()
  jsii_get_property("initialVlans")
end

#initial_vlans=(value) ⇒ Object 



427
428
429
430
431
 
# File 'evs/cfn_environment.rb', line 427

def initial_vlans=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EVS::CfnEnvironment::InitialVlansProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldnMuQ2ZuRW52aXJvbm1lbnQuSW5pdGlhbFZsYW5zUHJvcGVydHkifV19fQ==")), "initialVlans") unless value.nil?
  jsii_set_property("initialVlans", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



757
758
759
760
 
# File 'evs/cfn_environment.rb', line 757

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

#kms_key_id ⇒ String?

The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.

Returns:

  • (String, nil) 


436
437
438
 
# File 'evs/cfn_environment.rb', line 436

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



440
441
442
443
 
# File 'evs/cfn_environment.rb', line 440

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

#license_info ⇒ AWSCDK::IResolvable, AWSCDK::EVS::CfnEnvironment::LicenseInfoProperty

The license information that Amazon EVS requires to create an environment.

Returns:



313
314
315
 
# File 'evs/cfn_environment.rb', line 313

def license_info()
  jsii_get_property("licenseInfo")
end

#license_info=(value) ⇒ Object 



317
318
319
320
321
 
# File 'evs/cfn_environment.rb', line 317

def license_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EVS::CfnEnvironment::LicenseInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldnMuQ2ZuRW52aXJvbm1lbnQuTGljZW5zZUluZm9Qcm9wZXJ0eSJ9XX19")), "licenseInfo")
  jsii_set_property("licenseInfo", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


132
133
134
 
# File 'evs/cfn_environment.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'evs/cfn_environment.rb', line 115

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:



698
699
700
 
# File 'evs/cfn_environment.rb', line 698

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:



705
706
707
 
# File 'evs/cfn_environment.rb', line 705

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.



498
499
500
501
 
# File 'evs/cfn_environment.rb', line 498

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

#ref ⇒ String

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

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

Returns:

  • (String) 


151
152
153
 
# File 'evs/cfn_environment.rb', line 151

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:



716
717
718
719
 
# File 'evs/cfn_environment.rb', line 716

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


723
724
725
726
 
# File 'evs/cfn_environment.rb', line 723

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:



733
734
735
736
737
 
# File 'evs/cfn_environment.rb', line 733

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

#service_access_security_groups ⇒ AWSCDK::IResolvable, ...

The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.

Returns:



448
449
450
 
# File 'evs/cfn_environment.rb', line 448

def service_access_security_groups()
  jsii_get_property("serviceAccessSecurityGroups")
end

#service_access_security_groups=(value) ⇒ Object 



452
453
454
455
456
 
# File 'evs/cfn_environment.rb', line 452

def service_access_security_groups=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EVS::CfnEnvironment::ServiceAccessSecurityGroupsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldnMuQ2ZuRW52aXJvbm1lbnQuU2VydmljZUFjY2Vzc1NlY3VyaXR5R3JvdXBzUHJvcGVydHkifV19fQ==")), "serviceAccessSecurityGroups") unless value.nil?
  jsii_set_property("serviceAccessSecurityGroups", value)
end

#service_access_subnet_id ⇒ String

The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.

Returns:

  • (String) 


326
327
328
 
# File 'evs/cfn_environment.rb', line 326

def service_access_subnet_id()
  jsii_get_property("serviceAccessSubnetId")
end

#service_access_subnet_id=(value) ⇒ Object 



330
331
332
333
 
# File 'evs/cfn_environment.rb', line 330

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

#should_synthesize ⇒ Boolean

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

Returns:

  • (Boolean) —

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



742
743
744
 
# File 'evs/cfn_environment.rb', line 742

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

#site_id ⇒ String

The Broadcom Site ID that is associated with your Amazon EVS environment.

Returns:

  • (String) 


338
339
340
 
# File 'evs/cfn_environment.rb', line 338

def site_id()
  jsii_get_property("siteId")
end

#site_id=(value) ⇒ Object 



342
343
344
345
 
# File 'evs/cfn_environment.rb', line 342

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



141
142
143
 
# File 'evs/cfn_environment.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Metadata that assists with categorization and organization.

Returns:



461
462
463
 
# File 'evs/cfn_environment.rb', line 461

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



465
466
467
468
469
 
# File 'evs/cfn_environment.rb', line 465

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

#terms_accepted ⇒ Boolean, AWSCDK::IResolvable

Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment.

Returns:



350
351
352
 
# File 'evs/cfn_environment.rb', line 350

def terms_accepted()
  jsii_get_property("termsAccepted")
end

#terms_accepted=(value) ⇒ Object 



354
355
356
357
 
# File 'evs/cfn_environment.rb', line 354

def terms_accepted=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "termsAccepted")
  jsii_set_property("termsAccepted", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



474
475
476
 
# File 'evs/cfn_environment.rb', line 474

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


188
189
190
 
# File 'evs/cfn_environment.rb', line 188

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


198
199
200
 
# File 'evs/cfn_environment.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


748
749
750
751
 
# File 'evs/cfn_environment.rb', line 748

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

#vcf_hostnames ⇒ AWSCDK::IResolvable, AWSCDK::EVS::CfnEnvironment::VcfHostnamesProperty

The DNS hostnames to be used by the VCF management appliances in your environment.

Returns:



362
363
364
 
# File 'evs/cfn_environment.rb', line 362

def vcf_hostnames()
  jsii_get_property("vcfHostnames")
end

#vcf_hostnames=(value) ⇒ Object 



366
367
368
369
370
 
# File 'evs/cfn_environment.rb', line 366

def vcf_hostnames=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EVS::CfnEnvironment::VcfHostnamesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldnMuQ2ZuRW52aXJvbm1lbnQuVmNmSG9zdG5hbWVzUHJvcGVydHkifV19fQ==")), "vcfHostnames")
  jsii_set_property("vcfHostnames", value)
end

#vcf_version ⇒ String

The VCF version of the environment.

Returns:

  • (String) 


375
376
377
 
# File 'evs/cfn_environment.rb', line 375

def vcf_version()
  jsii_get_property("vcfVersion")
end

#vcf_version=(value) ⇒ Object 



379
380
381
382
 
# File 'evs/cfn_environment.rb', line 379

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

#vpc_id ⇒ String

The VPC associated with the environment.

Returns:

  • (String) 


387
388
389
 
# File 'evs/cfn_environment.rb', line 387

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



391
392
393
394
 
# File 'evs/cfn_environment.rb', line 391

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


487
488
489
490
491
492
 
# File 'evs/cfn_environment.rb', line 487

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