Class: AWSCDK::SecurityHub::CfnOrganizationConfiguration
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::SecurityHub::CfnOrganizationConfiguration
- Includes:
- IInspectable, Interfaces::AWSSecurityhub::IOrganizationConfigurationRef
- Defined in:
- security_hub/cfn_organization_configuration.rb
Overview
The AWS::SecurityHub::OrganizationConfiguration resource specifies the way that your AWS organization is configured in AWS Security Hub CSPM .
Specifically, you can use this resource to specify the configuration type for your organization and whether to automatically Security Hub CSPM and security standards in new member accounts. For more information, see Managing administrator and member accounts in the AWS Security Hub CSPM User Guide .
Class Method Summary collapse
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_organization_configuration(x) ⇒ Boolean
Checks whether the given object is a CfnOrganizationConfiguration.
- .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_member_account_limit_reached ⇒ AWSCDK::IResolvable
Whether the maximum number of allowed member accounts are already associated with the Security Hub CSPM administrator account.
-
#attr_organization_configuration_identifier ⇒ String
The organization configuration identifier, formatted as
AccountId/Region/securityhub-organization-configuration. -
#attr_status ⇒ String
Describes whether central configuration could be enabled as the
ConfigurationTypefor the organization. -
#attr_status_message ⇒ String
Provides an explanation if the value of
Statusis equal toFAILEDwhenConfigurationTypeis equal toCENTRAL. -
#auto_enable ⇒ Boolean, AWSCDK::IResolvable
Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.
- #auto_enable=(value) ⇒ Object
-
#auto_enable_standards ⇒ String?
Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization.
- #auto_enable_standards=(value) ⇒ Object
-
#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.
-
#configuration_type ⇒ String?
Indicates whether the organization uses local or central configuration.
- #configuration_type=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnOrganizationConfiguration
constructor
Create a new
AWS::SecurityHub::OrganizationConfiguration. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#organization_configuration_ref ⇒ AWSCDK::Interfaces::AWSSecurityhub::OrganizationConfigurationReference
A reference to a OrganizationConfiguration resource.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnOrganizationConfiguration
Create a new AWS::SecurityHub::OrganizationConfiguration.
19 20 21 22 23 24 25 |
# File 'security_hub/cfn_organization_configuration.rb', line 19 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnOrganizationConfigurationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjdXJpdHlodWIuQ2ZuT3JnYW5pemF0aW9uQ29uZmlndXJhdGlvblByb3BzIn0=")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
177 178 179 |
# File 'security_hub/cfn_organization_configuration.rb', line 177 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_securityhub.CfnOrganizationConfiguration", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_organization_configuration(x) ⇒ Boolean
Checks whether the given object is a CfnOrganizationConfiguration.
79 80 81 82 |
# File 'security_hub/cfn_organization_configuration.rb', line 79 def self.is_cfn_organization_configuration(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_securityhub.CfnOrganizationConfiguration", "isCfnOrganizationConfiguration", [x]) end |
.jsii_overridable_methods ⇒ Object
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 |
# File 'security_hub/cfn_organization_configuration.rb', line 27 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_member_account_limit_reached => { kind: :property, name: "attrMemberAccountLimitReached", is_optional: false }, :attr_organization_configuration_identifier => { kind: :property, name: "attrOrganizationConfigurationIdentifier", is_optional: false }, :attr_status => { kind: :property, name: "attrStatus", is_optional: false }, :attr_status_message => { kind: :property, name: "attrStatusMessage", is_optional: false }, :organization_configuration_ref => { kind: :property, name: "organizationConfigurationRef", is_optional: false }, :auto_enable => { kind: :property, name: "autoEnable", is_optional: false }, :auto_enable_standards => { kind: :property, name: "autoEnableStandards", is_optional: true }, :configuration_type => { kind: :property, name: "configurationType", 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).
292 293 294 295 |
# File 'security_hub/cfn_organization_configuration.rb', line 292 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.
304 305 306 307 |
# File 'security_hub/cfn_organization_configuration.rb', line 304 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.
314 315 316 317 |
# File 'security_hub/cfn_organization_configuration.rb', line 314 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.
325 326 327 328 329 |
# File 'security_hub/cfn_organization_configuration.rb', line 325 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.
382 383 384 385 386 |
# File 'security_hub/cfn_organization_configuration.rb', line 382 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.
392 393 394 395 |
# File 'security_hub/cfn_organization_configuration.rb', line 392 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).
404 405 406 407 408 |
# File 'security_hub/cfn_organization_configuration.rb', line 404 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.
417 418 419 420 |
# File 'security_hub/cfn_organization_configuration.rb', line 417 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:
439 440 441 442 443 444 |
# File 'security_hub/cfn_organization_configuration.rb', line 439 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_member_account_limit_reached ⇒ AWSCDK::IResolvable
Whether the maximum number of allowed member accounts are already associated with the Security Hub CSPM administrator account.
184 185 186 |
# File 'security_hub/cfn_organization_configuration.rb', line 184 def attr_member_account_limit_reached() jsii_get_property("attrMemberAccountLimitReached") end |
#attr_organization_configuration_identifier ⇒ String
The organization configuration identifier, formatted as AccountId/Region/securityhub-organization-configuration .
For example, 123456789012/us-east-1/securityhub-organization-configuration .
193 194 195 |
# File 'security_hub/cfn_organization_configuration.rb', line 193 def attr_organization_configuration_identifier() jsii_get_property("attrOrganizationConfigurationIdentifier") end |
#attr_status ⇒ String
Describes whether central configuration could be enabled as the ConfigurationType for the organization.
If your ConfigurationType is local configuration, then the value of Status is always ENABLED .
202 203 204 |
# File 'security_hub/cfn_organization_configuration.rb', line 202 def attr_status() jsii_get_property("attrStatus") end |
#attr_status_message ⇒ String
Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL .
209 210 211 |
# File 'security_hub/cfn_organization_configuration.rb', line 209 def () jsii_get_property("attrStatusMessage") end |
#auto_enable ⇒ Boolean, AWSCDK::IResolvable
Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.
223 224 225 |
# File 'security_hub/cfn_organization_configuration.rb', line 223 def auto_enable() jsii_get_property("autoEnable") end |
#auto_enable=(value) ⇒ Object
227 228 229 230 |
# File 'security_hub/cfn_organization_configuration.rb', line 227 def auto_enable=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoEnable") jsii_set_property("autoEnable", value) end |
#auto_enable_standards ⇒ String?
Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization.
235 236 237 |
# File 'security_hub/cfn_organization_configuration.rb', line 235 def auto_enable_standards() jsii_get_property("autoEnableStandards") end |
#auto_enable_standards=(value) ⇒ Object
239 240 241 242 |
# File 'security_hub/cfn_organization_configuration.rb', line 239 def auto_enable_standards=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoEnableStandards") unless value.nil? jsii_set_property("autoEnableStandards", value) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
130 131 132 |
# File 'security_hub/cfn_organization_configuration.rb', line 130 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
135 136 137 |
# File 'security_hub/cfn_organization_configuration.rb', line 135 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
448 449 450 451 |
# File 'security_hub/cfn_organization_configuration.rb', line 448 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}
140 141 142 |
# File 'security_hub/cfn_organization_configuration.rb', line 140 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
147 148 149 |
# File 'security_hub/cfn_organization_configuration.rb', line 147 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#configuration_type ⇒ String?
Indicates whether the organization uses local or central configuration.
247 248 249 |
# File 'security_hub/cfn_organization_configuration.rb', line 247 def configuration_type() jsii_get_property("configurationType") end |
#configuration_type=(value) ⇒ Object
251 252 253 254 |
# File 'security_hub/cfn_organization_configuration.rb', line 251 def configuration_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationType") unless value.nil? jsii_set_property("configurationType", value) end |
#creation_stack ⇒ Array<String>
92 93 94 |
# File 'security_hub/cfn_organization_configuration.rb', line 92 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
152 153 154 |
# File 'security_hub/cfn_organization_configuration.rb', line 152 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.
461 462 463 464 465 |
# File 'security_hub/cfn_organization_configuration.rb', line 461 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.
472 473 474 475 |
# File 'security_hub/cfn_organization_configuration.rb', line 472 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
542 543 544 545 |
# File 'security_hub/cfn_organization_configuration.rb', line 542 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).
104 105 106 |
# File 'security_hub/cfn_organization_configuration.rb', line 104 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
87 88 89 |
# File 'security_hub/cfn_organization_configuration.rb', line 87 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.
483 484 485 |
# File 'security_hub/cfn_organization_configuration.rb', line 483 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.
490 491 492 |
# File 'security_hub/cfn_organization_configuration.rb', line 490 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#organization_configuration_ref ⇒ AWSCDK::Interfaces::AWSSecurityhub::OrganizationConfigurationReference
A reference to a OrganizationConfiguration resource.
216 217 218 |
# File 'security_hub/cfn_organization_configuration.rb', line 216 def organization_configuration_ref() jsii_get_property("organizationConfigurationRef") end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
283 284 285 286 |
# File 'security_hub/cfn_organization_configuration.rb', line 283 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 }).
123 124 125 |
# File 'security_hub/cfn_organization_configuration.rb', line 123 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.
501 502 503 504 |
# File 'security_hub/cfn_organization_configuration.rb', line 501 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}
508 509 510 511 |
# File 'security_hub/cfn_organization_configuration.rb', line 508 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.
518 519 520 521 522 |
# File 'security_hub/cfn_organization_configuration.rb', line 518 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.
527 528 529 |
# File 'security_hub/cfn_organization_configuration.rb', line 527 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).
113 114 115 |
# File 'security_hub/cfn_organization_configuration.rb', line 113 def stack() jsii_get_property("stack") end |
#to_string ⇒ String
Returns a string representation of this construct.
259 260 261 |
# File 'security_hub/cfn_organization_configuration.rb', line 259 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.
160 161 162 |
# File 'security_hub/cfn_organization_configuration.rb', line 160 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.
170 171 172 |
# File 'security_hub/cfn_organization_configuration.rb', line 170 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
533 534 535 536 |
# File 'security_hub/cfn_organization_configuration.rb', line 533 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.
272 273 274 275 276 277 |
# File 'security_hub/cfn_organization_configuration.rb', line 272 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 |