CfnCloudExadataInfrastructure L1 construct
The AWS::ODB::CloudExadataInfrastructure resource creates an Exadata infrastructure.
An Exadata infrastructure provides the underlying compute and storage resources for Oracle Database workloads.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_odb as odb } from 'aws-cdk-lib';
const cfnCloudExadataInfrastructure = new odb.CfnCloudExadataInfrastructure(this, 'MyCfnCloudExadataInfrastructure', /* all optional props */ {
availabilityZone: 'availabilityZone',
availabilityZoneId: 'availabilityZoneId',
computeCount: 123,
customerContactsToSendToOci: [{
email: 'email',
}],
databaseServerType: 'databaseServerType',
displayName: 'displayName',
maintenanceWindow: {
customActionTimeoutInMins: 123,
daysOfWeek: ['daysOfWeek'],
hoursOfDay: [123],
isCustomActionTimeoutEnabled: false,
leadTimeInWeeks: 123,
months: ['months'],
patchingMode: 'patchingMode',
preference: 'preference',
weeksOfMonth: [123],
},
shape: 'shape',
storageCount: 123,
storageServerType: 'storageServerType',
tags: [{
key: 'key',
value: 'value',
}],
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_odb as odb
cfn_cloud_exadata_infrastructure = odb.CfnCloudExadataInfrastructure(self, "MyCfnCloudExadataInfrastructure",
availability_zone="availabilityZone",
availability_zone_id="availabilityZoneId",
compute_count=123,
customer_contacts_to_send_to_oci=[odb.CfnCloudExadataInfrastructure.CustomerContactProperty(
email="email"
)],
database_server_type="databaseServerType",
display_name="displayName",
maintenance_window=odb.CfnCloudExadataInfrastructure.MaintenanceWindowProperty(
custom_action_timeout_in_mins=123,
days_of_week=["daysOfWeek"],
hours_of_day=[123],
is_custom_action_timeout_enabled=False,
lead_time_in_weeks=123,
months=["months"],
patching_mode="patchingMode",
preference="preference",
weeks_of_month=[123]
),
shape="shape",
storage_count=123,
storage_server_type="storageServerType",
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.odb.*;
CfnCloudExadataInfrastructure cfnCloudExadataInfrastructure = CfnCloudExadataInfrastructure.Builder.create(this, "MyCfnCloudExadataInfrastructure")
.availabilityZone("availabilityZone")
.availabilityZoneId("availabilityZoneId")
.computeCount(123)
.customerContactsToSendToOci(List.of(CustomerContactProperty.builder()
.email("email")
.build()))
.databaseServerType("databaseServerType")
.displayName("displayName")
.maintenanceWindow(MaintenanceWindowProperty.builder()
.customActionTimeoutInMins(123)
.daysOfWeek(List.of("daysOfWeek"))
.hoursOfDay(List.of(123))
.isCustomActionTimeoutEnabled(false)
.leadTimeInWeeks(123)
.months(List.of("months"))
.patchingMode("patchingMode")
.preference("preference")
.weeksOfMonth(List.of(123))
.build())
.shape("shape")
.storageCount(123)
.storageServerType("storageServerType")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ODB;
var cfnCloudExadataInfrastructure = new CfnCloudExadataInfrastructure(this, "MyCfnCloudExadataInfrastructure", new CfnCloudExadataInfrastructureProps {
AvailabilityZone = "availabilityZone",
AvailabilityZoneId = "availabilityZoneId",
ComputeCount = 123,
CustomerContactsToSendToOci = new [] { new CustomerContactProperty {
Email = "email"
} },
DatabaseServerType = "databaseServerType",
DisplayName = "displayName",
MaintenanceWindow = new MaintenanceWindowProperty {
CustomActionTimeoutInMins = 123,
DaysOfWeek = new [] { "daysOfWeek" },
HoursOfDay = new [] { 123 },
IsCustomActionTimeoutEnabled = false,
LeadTimeInWeeks = 123,
Months = new [] { "months" },
PatchingMode = "patchingMode",
Preference = "preference",
WeeksOfMonth = new [] { 123 }
},
Shape = "shape",
StorageCount = 123,
StorageServerType = "storageServerType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCloudExadataInfrastructure := awscdk.Aws_odb.NewCfnCloudExadataInfrastructure(this, jsii.String("MyCfnCloudExadataInfrastructure"), &CfnCloudExadataInfrastructureProps{
AvailabilityZone: jsii.String("availabilityZone"),
AvailabilityZoneId: jsii.String("availabilityZoneId"),
ComputeCount: jsii.Number(123),
CustomerContactsToSendToOci: []interface{}{
&CustomerContactProperty{
Email: jsii.String("email"),
},
},
DatabaseServerType: jsii.String("databaseServerType"),
DisplayName: jsii.String("displayName"),
MaintenanceWindow: &MaintenanceWindowProperty{
CustomActionTimeoutInMins: jsii.Number(123),
DaysOfWeek: []*string{
jsii.String("daysOfWeek"),
},
HoursOfDay: []interface{}{
jsii.Number(123),
},
IsCustomActionTimeoutEnabled: jsii.Boolean(false),
LeadTimeInWeeks: jsii.Number(123),
Months: []*string{
jsii.String("months"),
},
PatchingMode: jsii.String("patchingMode"),
Preference: jsii.String("preference"),
WeeksOfMonth: []interface{}{
jsii.Number(123),
},
},
Shape: jsii.String("shape"),
StorageCount: jsii.Number(123),
StorageServerType: jsii.String("storageServerType"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
ts
new CfnCloudExadataInfrastructure(scope: Construct, id: string, props?: CfnCloudExadataInfrastructureProps)
python
CfnCloudExadataInfrastructure(scope: Construct, id: str, props: typing.Optional[CfnCloudExadataInfrastructureProps] = None)
java
new CfnCloudExadataInfrastructure(Construct scope, String id, CfnCloudExadataInfrastructureProps props)
csharp
new CfnCloudExadataInfrastructure(Construct scope, string id, CfnCloudExadataInfrastructureProps? props = null)
go
NewCfnCloudExadataInfrastructure(Scope Construct, Id *string, Props CfnCloudExadataInfrastructureProps)
Construct Props
availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string#The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.
availabilityZoneIdoptionalstringavailability_zone_idoptionalstravailabilityZoneIdoptionalStringAvailabilityZoneIdoptionalstringAvailabilityZoneIdoptional*string#The AZ ID of the AZ where the Exadata infrastructure is located.
Required when creating an Exadata infrastructure. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the infrastructure.
computeCountoptionalnumbercompute_countoptionalint | floatcomputeCountoptionalNumberComputeCountoptionaldoubleComputeCountoptional*float64#The number of database servers for the Exadata infrastructure.
Required when creating an Exadata infrastructure.
customerContactsToSendToOcioptionalIResolvable | IResolvable | CfnCloudExadataInfrastructure.CustomerContactProperty[]customer_contacts_to_send_to_ocioptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomerContactProperty]]]customerContactsToSendToOcioptionalIResolvableCustomerContactsToSendToOcioptionalIResolvableCustomerContactsToSendToOcioptionalinterface{}#The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
databaseServerTypeoptionalstringdatabase_server_typeoptionalstrdatabaseServerTypeoptionalStringDatabaseServerTypeoptionalstringDatabaseServerTypeoptional*string#The database server model type of the Exadata infrastructure.
For the list of valid model names, use the ListDbSystemShapes operation.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#The user-friendly name for the Exadata infrastructure.
Required when creating an Exadata infrastructure.
maintenanceWindowoptionalIResolvable | CfnCloudExadataInfrastructure.MaintenanceWindowPropertymaintenance_windowoptionaltyping.Union[IResolvable, MaintenanceWindowProperty]maintenanceWindowoptionalIResolvableMaintenanceWindowoptionalIResolvableMaintenanceWindowoptionalinterface{}#The scheduling details for the maintenance window.
Patching and system updates take place during the maintenance window.
The model name of the Exadata infrastructure.
Required when creating an Exadata infrastructure.
storageCountoptionalnumberstorage_countoptionalint | floatstorageCountoptionalNumberStorageCountoptionaldoubleStorageCountoptional*float64#The number of storage servers that are activated for the Exadata infrastructure.
Required when creating an Exadata infrastructure.
storageServerTypeoptionalstringstorage_server_typeoptionalstrstorageServerTypeoptionalStringStorageServerTypeoptionalstringStorageServerTypeoptional*string#The storage server model type of the Exadata infrastructure.
For the list of valid model names, use the ListDbSystemShapes operation.
Properties
attrActivatedStorageCountnumberattr_activated_storage_countint | floatattrActivatedStorageCountNumberAttrActivatedStorageCountdoubleAttrActivatedStorageCount*float64#The number of storage servers requested for the Exadata infrastructure.
attrAdditionalStorageCountnumberattr_additional_storage_countint | floatattrAdditionalStorageCountNumberAttrAdditionalStorageCountdoubleAttrAdditionalStorageCount*float64#The number of storage servers requested for the Exadata infrastructure.
attrAvailableStorageSizeInGBsnumberattr_available_storage_size_in_g_bsint | floatattrAvailableStorageSizeInGBsNumberAttrAvailableStorageSizeInGBsdoubleAttrAvailableStorageSizeInGBs*float64#The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
attrCloudExadataInfrastructureArnstringattr_cloud_exadata_infrastructure_arnstrattrCloudExadataInfrastructureArnStringAttrCloudExadataInfrastructureArnstringAttrCloudExadataInfrastructureArn*string#The Amazon Resource Name (ARN) for the Exadata infrastructure.
attrCloudExadataInfrastructureIdstringattr_cloud_exadata_infrastructure_idstrattrCloudExadataInfrastructureIdStringAttrCloudExadataInfrastructureIdstringAttrCloudExadataInfrastructureId*string#The unique identifier for the Exadata infrastructure.
attrComputeModelstringattr_compute_modelstrattrComputeModelStringAttrComputeModelstringAttrComputeModel*string#The OCI model compute model used when you create or clone an instance: ECPU or OCPU.
notes
An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
attrCpuCountnumberattr_cpu_countint | floatattrCpuCountNumberAttrCpuCountdoubleAttrCpuCount*float64#The total number of CPU cores that are allocated to the Exadata infrastructure.
attrDataStorageSizeInTBsIResolvableattr_data_storage_size_in_t_bsIResolvableattrDataStorageSizeInTBsIResolvableAttrDataStorageSizeInTBsIResolvableAttrDataStorageSizeInTBsIResolvable#The size of the Exadata infrastructure's data disk group, in terabytes (TB).
attrDbNodeStorageSizeInGBsnumberattr_db_node_storage_size_in_g_bsint | floatattrDbNodeStorageSizeInGBsNumberAttrDbNodeStorageSizeInGBsdoubleAttrDbNodeStorageSizeInGBs*float64#The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
attrDbServerIdsstring[]attr_db_server_idstyping.List[str]attrDbServerIdsList<String>AttrDbServerIdsstring[]AttrDbServerIds*[]*string#The list of database server identifiers for the Exadata infrastructure.
attrDbServerVersionstringattr_db_server_versionstrattrDbServerVersionStringAttrDbServerVersionstringAttrDbServerVersion*string#The software version of the database servers (dom0) in the Exadata infrastructure.
attrMaxCpuCountnumberattr_max_cpu_countint | floatattrMaxCpuCountNumberAttrMaxCpuCountdoubleAttrMaxCpuCount*float64#The total number of CPU cores available on the Exadata infrastructure.
attrMaxDataStorageInTBsIResolvableattr_max_data_storage_in_t_bsIResolvableattrMaxDataStorageInTBsIResolvableAttrMaxDataStorageInTBsIResolvableAttrMaxDataStorageInTBsIResolvable#The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
attrMaxDbNodeStorageSizeInGBsnumberattr_max_db_node_storage_size_in_g_bsint | floatattrMaxDbNodeStorageSizeInGBsNumberAttrMaxDbNodeStorageSizeInGBsdoubleAttrMaxDbNodeStorageSizeInGBs*float64#The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
attrMaxMemoryInGBsnumberattr_max_memory_in_g_bsint | floatattrMaxMemoryInGBsNumberAttrMaxMemoryInGBsdoubleAttrMaxMemoryInGBs*float64#The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
attrMemorySizeInGBsnumberattr_memory_size_in_g_bsint | floatattrMemorySizeInGBsNumberAttrMemorySizeInGBsdoubleAttrMemorySizeInGBs*float64#The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
The OCID of the Exadata infrastructure.
attrOciResourceAnchorNamestringattr_oci_resource_anchor_namestrattrOciResourceAnchorNameStringAttrOciResourceAnchorNamestringAttrOciResourceAnchorName*string#The name of the OCI resource anchor for the Exadata infrastructure.
The HTTPS link to the Exadata infrastructure in OCI.
attrStorageServerVersionstringattr_storage_server_versionstrattrStorageServerVersionStringAttrStorageServerVersionstringAttrStorageServerVersion*string#The software version of the storage servers on the Exadata infrastructure.
attrTotalStorageSizeInGBsnumberattr_total_storage_size_in_g_bsint | floatattrTotalStorageSizeInGBsNumberAttrTotalStorageSizeInGBsdoubleAttrTotalStorageSizeInGBs*float64#The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.
availabilityZonemay be undefinedstringavailability_zonemay be undefinedstravailabilityZonemay be undefinedStringAvailabilityZonemay be undefinedstringAvailabilityZonemay be undefined*string#The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
availabilityZoneIdmay be undefinedstringavailability_zone_idmay be undefinedstravailabilityZoneIdmay be undefinedStringAvailabilityZoneIdmay be undefinedstringAvailabilityZoneIdmay be undefined*string#The AZ ID of the AZ where the Exadata infrastructure is located.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
cloudExadataInfrastructureRefCloudExadataInfrastructureReferencecloud_exadata_infrastructure_refCloudExadataInfrastructureReferencecloudExadataInfrastructureRefCloudExadataInfrastructureReferenceCloudExadataInfrastructureRefCloudExadataInfrastructureReferenceCloudExadataInfrastructureRefCloudExadataInfrastructureReference#A reference to a CloudExadataInfrastructure resource.
computeCountmay be undefinednumbercompute_countmay be undefinedint | floatcomputeCountmay be undefinedNumberComputeCountmay be undefineddoubleComputeCountmay be undefined*float64#The number of database servers for the Exadata infrastructure.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#customerContactsToSendToOcimay be undefinedIResolvable | IResolvable | CfnCloudExadataInfrastructure.CustomerContactProperty[]customer_contacts_to_send_to_ocimay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomerContactProperty]]]customerContactsToSendToOcimay be undefinedIResolvableCustomerContactsToSendToOcimay be undefinedIResolvableCustomerContactsToSendToOcimay be undefinedinterface{}#The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
databaseServerTypemay be undefinedstringdatabase_server_typemay be undefinedstrdatabaseServerTypemay be undefinedStringDatabaseServerTypemay be undefinedstringDatabaseServerTypemay be undefined*string#The database server model type of the Exadata infrastructure.
displayNamemay be undefinedstringdisplay_namemay be undefinedstrdisplayNamemay be undefinedStringDisplayNamemay be undefinedstringDisplayNamemay be undefined*string#The user-friendly name for the Exadata infrastructure.
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 overrideLogicalId(newLogicalId).
maintenanceWindowmay be undefinedIResolvable | CfnCloudExadataInfrastructure.MaintenanceWindowPropertymaintenance_windowmay be undefinedtyping.Union[IResolvable, MaintenanceWindowProperty]maintenanceWindowmay be undefinedIResolvableMaintenanceWindowmay be undefinedIResolvableMaintenanceWindowmay be undefinedinterface{}#The scheduling details for the maintenance window.
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 }).
shapemay be undefinedstringshapemay be undefinedstrshapemay be undefinedStringShapemay be undefinedstringShapemay be undefined*string#The model name of the Exadata infrastructure.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
storageCountmay be undefinednumberstorage_countmay be undefinedint | floatstorageCountmay be undefinedNumberStorageCountmay be undefineddoubleStorageCountmay be undefined*float64#The number of storage servers that are activated for the Exadata infrastructure.
storageServerTypemay be undefinedstringstorage_server_typemay be undefinedstrstorageServerTypemay be undefinedStringStorageServerTypemay be undefinedstringStorageServerTypemay be undefined*string#The storage server model type of the Exadata infrastructure.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride 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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride 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
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#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.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
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:
arnForCloudExadataInfrastructure(resource: ICloudExadataInfrastructureRef): string@staticmethod def arn_for_cloud_exadata_infrastructure(resource: ICloudExadataInfrastructureRef) -> strpublic static String arnForCloudExadataInfrastructure(ICloudExadataInfrastructureRef resource)public static string ArnForCloudExadataInfrastructure(ICloudExadataInfrastructureRef resource)func ArnForCloudExadataInfrastructure(Resource ICloudExadataInfrastructureRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) 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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnCloudExadataInfrastructure(x: any): boolean@staticmethod def is_cfn_cloud_exadata_infrastructure(x: Any) -> boolpublic static Boolean isCfnCloudExadataInfrastructure(Object x)public static bool IsCfnCloudExadataInfrastructure(object x)func IsCfnCloudExadataInfrastructure(X interface{}) *boolstatic#Checks whether the given object is a CfnCloudExadataInfrastructure.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#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.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.