software.amazon.awscdk.core

Class CfnResource

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

CfnAccelerator, CfnAcceptedPortfolioShare, CfnAccessKey, CfnAccessPoint, CfnAccessPoint, CfnAccessPoint, CfnAccessPoint, CfnAccessPointPolicy, CfnAccessPolicy, CfnAccount, CfnAccount, CfnAccountAuditConfiguration, CfnACL, CfnActivity, CfnAddon, CfnAddon, CfnADMChannel, CfnAgent, CfnAggregationAuthorization, CfnAlarm, CfnAlarm, CfnAlert, CfnAlias, CfnAlias, CfnAlias, CfnAnalysis, CfnAnalyzer, CfnAnomalyDetector, CfnAnomalyDetector, CfnAnomalyMonitor, CfnAnomalySubscription, CfnApi, CfnApi, CfnApiCache, CfnApiDestination, CfnApiGatewayManagedOverrides, CfnApiKey, CfnApiKey, CfnApiMapping, CfnApiMappingV2, CfnApiV2, CfnAPNSChannel, CfnAPNSSandboxChannel, CfnAPNSVoipChannel, CfnAPNSVoipSandboxChannel, CfnApp, CfnApp, CfnApp, CfnApp, CfnApp, CfnAppBlock, CfnAppImageConfig, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplication, CfnApplicationCloudWatchLoggingOption, CfnApplicationCloudWatchLoggingOptionV2, CfnApplicationEntitlementAssociation, CfnApplicationFleetAssociation, CfnApplicationInstance, CfnApplicationOutput, CfnApplicationOutput, CfnApplicationOutputV2, CfnApplicationReferenceDataSource, CfnApplicationReferenceDataSource, CfnApplicationReferenceDataSourceV2, CfnApplicationSettings, CfnApplicationV2, CfnApplicationVersion, CfnAppMonitor, CfnArchive, CfnAssessment, CfnAssessmentTarget, CfnAssessmentTemplate, CfnAsset, CfnAsset, CfnAssetModel, CfnAssignment, CfnAssistant, CfnAssistantAssociation, CfnAssociation, CfnAttributeGroup, CfnAttributeGroupAssociation, CfnAuthorizer, CfnAuthorizer, CfnAuthorizer, CfnAuthorizerV2, CfnAutoScalingGroup, CfnBackupPlan, CfnBackupSelection, CfnBackupVault, CfnBaiduChannel, CfnBasePathMapping, CfnBot, CfnBotAlias, CfnBotVersion, CfnBranch, CfnBroker, CfnBucket, CfnBucket, CfnBucket, CfnBucketPolicy, CfnBucketPolicy, CfnBudget, CfnBudgetsAction, CfnBuild, CfnByteMatchSet, CfnByteMatchSet, CfnCacheCluster, CfnCachePolicy, CfnCampaign, CfnCanary, CfnCapacityProvider, CfnCapacityReservation, CfnCapacityReservationFleet, CfnCarrierGateway, CfnCell, CfnCertificate, CfnCertificate, CfnCertificate, CfnCertificate, CfnCertificateAuthority, CfnCertificateAuthorityActivation, CfnChannel, CfnChannel, CfnChannel, CfnChannel, CfnClassifier, CfnClientCertificate, CfnClientVpnAuthorizationRule, CfnClientVpnEndpoint, CfnClientVpnRoute, CfnClientVpnTargetNetworkAssociation, CfnCloudFormationProduct, CfnCloudFormationProvisionedProduct, CfnCloudFrontOriginAccessIdentity, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnCluster, CfnClusterCapacityProviderAssociations, CfnClusterParameterGroup, CfnClusterSecurityGroup, CfnClusterSecurityGroupIngress, CfnClusterSubnetGroup, CfnCodeRepository, CfnCodeSigningConfig, CfnComponent, CfnComponent, CfnComponentVersion, CfnCompositeAlarm, CfnComputeEnvironment, CfnConfig, CfnConfigRule, CfnConfiguration, CfnConfigurationAggregator, CfnConfigurationAssociation, CfnConfigurationProfile, CfnConfigurationRecorder, CfnConfigurationSet, CfnConfigurationSet, CfnConfigurationSetEventDestination, CfnConfigurationSetEventDestination, CfnConfigurationTemplate, CfnConformancePack, CfnConnection, CfnConnection, CfnConnection, CfnConnectionAlias, CfnConnectorDefinition, CfnConnectorDefinitionVersion, CfnConnectorProfile, CfnContact, CfnContactChannel, CfnContactFlow, CfnContactFlowModule, CfnContactList, CfnContainer, CfnContainerRecipe, CfnControlPanel, CfnCoreDefinition, CfnCoreDefinitionVersion, CfnCostCategory, CfnCrawler, CfnCustomActionType, CfnCustomDataIdentifier, CfnCustomerGateway, CfnCustomerGatewayAssociation, CfnCustomMetric, CfnCustomResource, CfnCustomResource, CfnDashboard, CfnDashboard, CfnDashboard, CfnDatabase, CfnDatabase, CfnDatabase, CfnDataCatalog, CfnDataCatalogEncryptionSettings, CfnDataflowEndpointGroup, CfnDataLakeSettings, CfnDataQualityJobDefinition, CfnDataset, CfnDataset, CfnDataset, CfnDataSet, CfnDatasetGroup, CfnDataSource, CfnDataSource, CfnDataSource, CfnDatastore, CfnDBCluster, CfnDBCluster, CfnDBCluster, CfnDBClusterParameterGroup, CfnDBClusterParameterGroup, CfnDBClusterParameterGroup, CfnDBInstance, CfnDBInstance, CfnDBInstance, CfnDBParameterGroup, CfnDBParameterGroup, CfnDBProxy, CfnDBProxyEndpoint, CfnDBProxyTargetGroup, CfnDBSecurityGroup, CfnDBSecurityGroupIngress, CfnDBSubnetGroup, CfnDBSubnetGroup, CfnDBSubnetGroup, CfnDedicatedIpPool, CfnDeliveryChannel, CfnDeliveryStream, CfnDeployment, CfnDeployment, CfnDeployment, CfnDeploymentConfig, CfnDeploymentGroup, CfnDeploymentStrategy, CfnDeploymentV2, CfnDestination, CfnDestination, CfnDetector, CfnDetector, CfnDetectorModel, CfnDevEndpoint, CfnDevice, CfnDevice, CfnDevice, CfnDeviceDefinition, CfnDeviceDefinitionVersion, CfnDeviceFleet, CfnDeviceProfile, CfnDHCPOptions, CfnDimension, CfnDirectoryConfig, CfnDiscoverer, CfnDisk, CfnDistribution, CfnDistributionConfiguration, CfnDNSSEC, CfnDocument, CfnDocumentationPart, CfnDocumentationVersion, CfnDomain, CfnDomain, CfnDomain, CfnDomain, CfnDomain, CfnDomain, CfnDomain, CfnDomainConfiguration, CfnDomainName, CfnDomainName, CfnDomainName, CfnDomainNameApiAssociation, CfnDomainNameV2, CfnEC2Fleet, CfnEgressOnlyInternetGateway, CfnEIP, CfnEIPAssociation, CfnElasticLoadBalancerAttachment, CfnEmailChannel, CfnEmailTemplate, CfnEnclaveCertificateIamRoleAssociation, CfnEndpoint, CfnEndpoint, CfnEndpoint, CfnEndpointAccess, CfnEndpointAuthorization, CfnEndpointConfig, CfnEndpointGroup, CfnEntitlement, CfnEntityType, CfnEnvironment, CfnEnvironment, CfnEnvironment, CfnEnvironment, CfnEnvironment, CfnEnvironmentEC2, CfnEventBus, CfnEventBusPolicy, CfnEventIntegration, CfnEventInvokeConfig, CfnEventSourceMapping, CfnEventStream, CfnEventSubscription, CfnEventSubscription, CfnEventSubscription, CfnEventType, CfnExperiment, CfnExperimentTemplate, CfnFaq, CfnFargateProfile, CfnFargateProfile, CfnFeature, CfnFeatureGroup, CfnFHIRDatastore, CfnFileSystem, CfnFileSystem, CfnFilter, CfnFilter, CfnFindingsFilter, CfnFirewall, CfnFirewallDomainList, CfnFirewallPolicy, CfnFirewallRuleGroup, CfnFirewallRuleGroupAssociation, CfnFleet, CfnFleet, CfnFleet, CfnFleetMetric, CfnFlow, CfnFlow, CfnFlowEntitlement, CfnFlowLog, CfnFlowOutput, CfnFlowSource, CfnFlowTemplate, CfnFlowVpcInterface, CfnFramework, CfnFunction, CfnFunction, CfnFunction, CfnFunctionConfiguration, CfnFunctionDefinition, CfnFunctionDefinitionVersion, CfnFuotaTask, CfnGameServerGroup, CfnGameSessionQueue, CfnGateway, CfnGatewayResponse, CfnGatewayRoute, CfnGatewayRouteTableAssociation, CfnGCMChannel, CfnGeofenceCollection, CfnGeoMatchSet, CfnGitHubRepository, CfnGlobalCluster, CfnGlobalNetwork, CfnGlobalReplicationGroup, CfnGlobalTable, CfnGrant, CfnGraph, CfnGraphQLApi, CfnGraphQLSchema, CfnGroup, CfnGroup, CfnGroup, CfnGroup, CfnGroupVersion, CfnHealthCheck, CfnHost, CfnHostedConfigurationVersion, CfnHostedZone, CfnHoursOfOperation, CfnHttpApi, CfnHttpNamespace, CfnHub, CfnIdentity, CfnIdentityPool, CfnIdentityPoolRoleAttachment, CfnImage, CfnImage, CfnImageBuilder, CfnImagePipeline, CfnImageRecipe, CfnImageVersion, CfnInAppTemplate, CfnIndex, CfnInferenceScheduler, CfnInfrastructureConfiguration, CfnInput, CfnInput, CfnInputSecurityGroup, CfnInsightRule, CfnInstance, CfnInstance, CfnInstance, CfnInstance, CfnInstanceAccessControlAttributeConfiguration, CfnInstanceFleetConfig, CfnInstanceGroupConfig, CfnInstanceProfile, CfnIntegration, CfnIntegration, CfnIntegrationResponse, CfnIntegrationResponseV2, CfnIntegrationV2, CfnInternetGateway, CfnIPAM, CfnIPAMAllocation, CfnIPAMPool, CfnIPAMScope, CfnIPSet, CfnIPSet, CfnIPSet, CfnIPSet, CfnJob, CfnJob, CfnJobDefinition, CfnJobQueue, CfnJobTemplate, CfnJobTemplate, CfnKey, CfnKeyGroup, CfnKeySigningKey, CfnKeyspace, CfnKnowledgeBase, CfnLabel, CfnLaunch, CfnLaunchConfiguration, CfnLaunchNotificationConstraint, CfnLaunchProfile, CfnLaunchRoleConstraint, CfnLaunchTemplate, CfnLaunchTemplateConstraint, CfnLayer, CfnLayerVersion, CfnLayerVersion, CfnLayerVersionPermission, CfnLedger, CfnLicense, CfnLifecycleHook, CfnLifecyclePolicy, CfnLink, CfnLinkAssociation, CfnListener, CfnListener, CfnListenerCertificate, CfnListenerRule, CfnLoadBalancer, CfnLoadBalancer, CfnLoadBalancer, CfnLoadBalancerTlsCertificate, CfnLocalGatewayRoute, CfnLocalGatewayRouteTableVPCAssociation, CfnLocationEFS, CfnLocationFSxWindows, CfnLocationHDFS, CfnLocationNFS, CfnLocationObjectStorage, CfnLocationS3, CfnLocationSMB, CfnLoggerDefinition, CfnLoggerDefinitionVersion, CfnLogging, CfnLoggingConfiguration, CfnLoggingConfiguration, CfnLogGroup, CfnLogStream, CfnMacro, CfnMacro, CfnMaintenanceWindow, CfnMaintenanceWindowTarget, CfnMaintenanceWindowTask, CfnManagedPolicy, CfnMap, CfnMaster, CfnMatchmakingConfiguration, CfnMatchmakingRuleSet, CfnMember, CfnMember, CfnMemberInvitation, CfnMesh, CfnMethod, CfnMetricFilter, CfnMetricStream, CfnMicrosoftAD, CfnMissionProfile, CfnMitigationAction, CfnMLTransform, CfnModel, CfnModel, CfnModel, CfnModelBiasJobDefinition, CfnModelExplainabilityJobDefinition, CfnModelPackageGroup, CfnModelQualityJobDefinition, CfnModelV2, CfnModuleDefaultVersion, CfnModuleDefaultVersion, CfnModuleVersion, CfnModuleVersion, CfnMonitoringSchedule, CfnMountTarget, CfnMulticastGroup, CfnMultiRegionAccessPoint, CfnMultiRegionAccessPointPolicy, CfnNamedQuery, CfnNatGateway, CfnNetworkAcl, CfnNetworkAclEntry, CfnNetworkInsightsAccessScope, CfnNetworkInsightsAccessScopeAnalysis, CfnNetworkInsightsAnalysis, CfnNetworkInsightsPath, CfnNetworkInterface, CfnNetworkInterfaceAttachment, CfnNetworkInterfacePermission, CfnNode, CfnNodegroup, CfnNodegroup, CfnNotebookInstance, CfnNotebookInstanceLifecycleConfig, CfnNotificationChannel, CfnNotificationChannel, CfnNotificationRule, CfnObjectType, CfnOIDCProvider, CfnOptionGroup, CfnOrganizationConfigRule, CfnOrganizationConformancePack, CfnOriginEndpoint, CfnOriginRequestPolicy, CfnOutcome, CfnPackage, CfnPackageVersion, CfnPackagingConfiguration, CfnPackagingGroup, CfnParameter, CfnParameterGroup, CfnParameterGroup, CfnParameterGroup, CfnPartition, CfnPartnerAccount, CfnPatchBaseline, CfnPermission, CfnPermission, CfnPermissions, CfnPermissionSet, CfnPipeline, CfnPipeline, CfnPipeline, CfnPipeline, CfnPlaceIndex, CfnPlacement, CfnPlacementGroup, CfnPlaybackKeyPair, CfnPolicy, CfnPolicy, CfnPolicy, CfnPolicyPrincipalAttachment, CfnPortal, CfnPortfolio, CfnPortfolioPrincipalAssociation, CfnPortfolioProductAssociation, CfnPortfolioShare, CfnPrefixList, CfnPreparedStatement, CfnPreset, CfnPrimaryTaskSet, CfnPrivateDnsNamespace, CfnProfilePermission, CfnProfilingGroup, CfnProject, CfnProject, CfnProject, CfnProject, CfnProject, CfnProject, CfnProject, CfnProject, CfnProvisioningTemplate, CfnPublicDnsNamespace, CfnPublicKey, CfnPublicRepository, CfnPublicTypeVersion, CfnPublicTypeVersion, CfnPublisher, CfnPublisher, CfnPushTemplate, CfnQueryDefinition, CfnQueue, CfnQueue, CfnQueuePolicy, CfnQuickConnect, CfnRateBasedRule, CfnReadinessCheck, CfnRealtimeLogConfig, CfnReceiptFilter, CfnReceiptRule, CfnReceiptRuleSet, CfnRecipe, CfnRecordingConfiguration, CfnRecordSet, CfnRecordSetGroup, CfnRecoveryGroup, CfnRegexPatternSet, CfnRegexPatternSet, CfnRegistry, CfnRegistry, CfnRegistryPolicy, CfnRegistryPolicy, CfnRemediationConfiguration, CfnReplicaKey, CfnReplicationConfiguration, CfnReplicationGroup, CfnReplicationInstance, CfnReplicationSet, CfnReplicationSubnetGroup, CfnReplicationTask, CfnReportDefinition, CfnReportGroup, CfnReportPlan, CfnRepository, CfnRepository, CfnRepository, CfnRepositoryAssociation, CfnRequestValidator, CfnResiliencyPolicy, CfnResolver, CfnResolverConfig, CfnResolverDNSSECConfig, CfnResolverEndpoint, CfnResolverQueryLoggingConfig, CfnResolverQueryLoggingConfigAssociation, CfnResolverRule, CfnResolverRuleAssociation, CfnResource, CfnResource, CfnResourceAssociation, CfnResourceCollection, CfnResourceDataSync, CfnResourceDefaultVersion, CfnResourceDefaultVersion, CfnResourceDefinition, CfnResourceDefinitionVersion, CfnResourceGroup, CfnResourcePolicy, CfnResourcePolicy, CfnResourcePolicy, CfnResourceSet, CfnResourceShare, CfnResourceSpecificLogging, CfnResourceUpdateConstraint, CfnResourceVersion, CfnResourceVersion, CfnResponseHeadersPolicy, CfnResponsePlan, CfnRestApi, CfnRobot, CfnRobotApplication, CfnRobotApplicationVersion, CfnRole, CfnRotationSchedule, CfnRoute, CfnRoute, CfnRoute, CfnRoute, CfnRouteCalculator, CfnRouteResponse, CfnRouteResponseV2, CfnRouteTable, CfnRouteV2, CfnRoutingControl, CfnRule, CfnRule, CfnRule, CfnRuleGroup, CfnRuleGroup, CfnRuleGroupsNamespace, CfnRuleset, CfnSafetyRule, CfnSAMLProvider, CfnSamplingRule, CfnScalableTarget, CfnScalingPlan, CfnScalingPolicy, CfnScalingPolicy, CfnSchedule, CfnScheduledAction, CfnScheduledAction, CfnScheduledAudit, CfnScheduledQuery, CfnSchedulingPolicy, CfnSchema, CfnSchema, CfnSchemaVersion, CfnSchemaVersionMetadata, CfnScript, CfnSecret, CfnSecretTargetAttachment, CfnSecurityConfiguration, CfnSecurityConfiguration, CfnSecurityGroup, CfnSecurityGroup, CfnSecurityGroupEgress, CfnSecurityGroupIngress, CfnSecurityGroupIngress, CfnSecurityProfile, CfnSegment, CfnServer, CfnServer, CfnServerCertificate, CfnService, CfnService, CfnService, CfnService, CfnServiceAction, CfnServiceActionAssociation, CfnServiceLinkedRole, CfnServiceProfile, CfnSession, CfnSignalingChannel, CfnSigningProfile, CfnSimpleAD, CfnSimpleTable, CfnSimulationApplication, CfnSimulationApplicationVersion, CfnSite, CfnSizeConstraintSet, CfnSizeConstraintSet, CfnSkill, CfnSlackChannelConfiguration, CfnSMSChannel, CfnSmsTemplate, CfnSourceCredential, CfnSpotFleet, CfnSqlInjectionMatchSet, CfnSqlInjectionMatchSet, CfnStack, CfnStack, CfnStack, CfnStack, CfnStackFleetAssociation, CfnStackSet, CfnStackSet, CfnStackSetConstraint, CfnStackUserAssociation, CfnStage, CfnStage, CfnStageV2, CfnStateMachine, CfnStateMachine, CfnStaticIp, CfnStep, CfnStorageLens, CfnStoredQuery, CfnStream, CfnStream, CfnStream, CfnStreamConsumer, CfnStreamingDistribution, CfnStreamingImage, CfnStreamKey, CfnStudio, CfnStudio, CfnStudioComponent, CfnStudioSessionMapping, CfnSubnet, CfnSubnetCidrBlock, CfnSubnetGroup, CfnSubnetGroup, CfnSubnetGroup, CfnSubnetNetworkAclAssociation, CfnSubnetRouteTableAssociation, CfnSubscription, CfnSubscriptionDefinition, CfnSubscriptionDefinitionVersion, CfnSubscriptionFilter, CfnSuiteDefinition, CfnTable, CfnTable, CfnTable, CfnTable, CfnTagOption, CfnTagOptionAssociation, CfnTargetGroup, CfnTask, CfnTaskDefinition, CfnTaskDefinition, CfnTaskSet, CfnTemplate, CfnTemplate, CfnTheme, CfnTheme, CfnThing, CfnThingPrincipalAttachment, CfnThreatIntelSet, CfnTopic, CfnTopicPolicy, CfnTopicRule, CfnTopicRuleDestination, CfnTracker, CfnTrackerConsumer, CfnTrafficMirrorFilter, CfnTrafficMirrorFilterRule, CfnTrafficMirrorSession, CfnTrafficMirrorTarget, CfnTrail, CfnTransitGateway, CfnTransitGatewayAttachment, CfnTransitGatewayConnect, CfnTransitGatewayMulticastDomain, CfnTransitGatewayMulticastDomainAssociation, CfnTransitGatewayMulticastGroupMember, CfnTransitGatewayMulticastGroupSource, CfnTransitGatewayPeeringAttachment, CfnTransitGatewayRegistration, CfnTransitGatewayRoute, CfnTransitGatewayRouteTable, CfnTransitGatewayRouteTableAssociation, CfnTransitGatewayRouteTablePropagation, CfnTransitGatewayVpcAttachment, CfnTrigger, CfnTypeActivation, CfnTypeActivation, CfnUsagePlan, CfnUsagePlanKey, CfnUser, CfnUser, CfnUser, CfnUser, CfnUser, CfnUser, CfnUserGroup, CfnUserHierarchyGroup, CfnUserPool, CfnUserPoolClient, CfnUserPoolDomain, CfnUserPoolGroup, CfnUserPoolIdentityProvider, CfnUserPoolResourceServer, CfnUserPoolRiskConfigurationAttachment, CfnUserPoolUICustomizationAttachment, CfnUserPoolUser, CfnUserPoolUserToGroupAttachment, CfnUserProfile, CfnUserProfile, CfnUserToGroupAddition, CfnVariable, CfnVersion, CfnVirtualCluster, CfnVirtualGateway, CfnVirtualMFADevice, CfnVirtualNode, CfnVirtualRouter, CfnVirtualService, CfnVoiceChannel, CfnVolume, CfnVolume, CfnVolumeAttachment, CfnVPC, CfnVPCCidrBlock, CfnVPCDHCPOptionsAssociation, CfnVPCEndpoint, CfnVPCEndpointConnectionNotification, CfnVPCEndpointService, CfnVPCEndpointServicePermissions, CfnVPCGatewayAttachment, CfnVpcLink, CfnVpcLink, CfnVPCPeeringConnection, CfnVPNConnection, CfnVPNConnectionRoute, CfnVPNGateway, CfnVPNGatewayRoutePropagation, CfnWaitCondition, CfnWaitCondition, CfnWaitConditionHandle, CfnWaitConditionHandle, CfnWarmPool, CfnWebACL, CfnWebACL, CfnWebACL, CfnWebACLAssociation, CfnWebACLAssociation, CfnWebhook, CfnWirelessDevice, CfnWirelessGateway, CfnWorkflow, CfnWorkflow, CfnWorkGroup, CfnWorkspace, CfnWorkspace, CfnWorkteam, CfnXssMatchSet, CfnXssMatchSet

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-01-20T19:49:54.036Z")
public class CfnResource
extends CfnRefElement

Represents a CloudFormation resource.

Example:

 Bucket bucket;
 CfnResource cfnBucket = (CfnResource)bucket.node.findChild("Resource");
 cfnBucket.applyRemovalPolicy(RemovalPolicy.DESTROY);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResource.Builder A fluent builder for CfnResource.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CfnResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnResource(software.constructs.Construct scope, java.lang.String id, CfnResourceProps props) Creates a resource construct.

Method Summary

Modifier and Type	Method and Description
void	addDeletionOverride(java.lang.String path) Syntactic sugar for `addOverride(path, undefined)`.
void	addDependsOn(CfnResource target) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
void	addMetadata(java.lang.String key, java.lang.Object value) Add a value to the CloudFormation Resource Metadata.
void	addOverride(java.lang.String path, java.lang.Object value) Adds an override to the synthesized CloudFormation resource.
void	addPropertyDeletionOverride(java.lang.String propertyPath) Adds an override that deletes the value of a property from the resource definition.
void	addPropertyOverride(java.lang.String propertyPath, java.lang.Object value) Adds an override to a resource property.
void	applyRemovalPolicy() Sets the deletion policy of the resource based on the removal policy specified.
void	applyRemovalPolicy(RemovalPolicy policy) Sets the deletion policy of the resource based on the removal policy specified.
void	applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options) Sets the deletion policy of the resource based on the removal policy specified.
Reference	getAtt(java.lang.String attributeName) Returns a token for an runtime attribute of this resource.
ICfnResourceOptions	getCfnOptions() Options for this resource, such as condition, update policy etc.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCfnResourceType() AWS resource type.
java.lang.Object	getMetadata(java.lang.String key) Retrieve a value value from the CloudFormation Resource Metadata.
protected java.util.Map<java.lang.String,java.lang.Object>	getUpdatedProperites() Return properties modified after initiation.
static java.lang.Boolean	isCfnResource(software.constructs.IConstruct construct) Check whether the given construct is a CfnResource.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
protected java.lang.Boolean	shouldSynthesize() Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
java.lang.String	toString() Returns a string representation of this construct.
protected void	validateProperties(java.lang.Object _properties)

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CfnResource

protected CfnResource(software.amazon.jsii.JsiiObjectRef objRef)

CfnResource

protected CfnResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResource

public CfnResource(software.constructs.Construct scope,
                   java.lang.String id,
                   CfnResourceProps props)

Creates a resource construct.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

isCfnResource

public static java.lang.Boolean isCfnResource(software.constructs.IConstruct construct)

Check whether the given construct is a CfnResource.

Parameters:

construct - This parameter is required.

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for `addOverride(path, undefined)`.

Parameters:

path - The path of the value to delete. This parameter is required.

addDependsOn

public void addDependsOn(CfnResource target)

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:

target - This parameter is required.

addMetadata

public void addMetadata(java.lang.String key,
                        java.lang.Object value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key - This parameter is required.

value - This parameter is required.

See Also:

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

addOverride

public void addOverride(java.lang.String path,
                        java.lang.Object value)

Adds an override to the synthesized CloudFormation resource.

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,

 cfnResource.addOverride("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", List.of("myattribute"));
 cfnResource.addOverride("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE");
 

would add the overrides

 "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
 }
 

Parameters:

path - - The path of the property, you can use dot notation to override values in complex types. This parameter is required.

value - - The value. This parameter is required.

addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

propertyPath - The path to the property. This parameter is required.

addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath,
                                java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

propertyPath - The path of the property. This parameter is required.

value - The value. This parameter is required.

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy,
                               RemovalPolicyOptions options)

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

Parameters:

policy -

options -

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

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

Parameters:

policy -

applyRemovalPolicy

public void applyRemovalPolicy()

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

getAtt

public Reference getAtt(java.lang.String attributeName)

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:

attributeName - The name of the attribute. This parameter is required.

getMetadata

public java.lang.Object getMetadata(java.lang.String key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key - This parameter is required.

See Also:

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Parameters:

props - This parameter is required.

shouldSynthesize

protected java.lang.Boolean shouldSynthesize()

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

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this construct.

Returns:

a string representation of this resource

validateProperties

protected void validateProperties(java.lang.Object _properties)

Parameters:

_properties - This parameter is required.

getCfnOptions

public ICfnResourceOptions getCfnOptions()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

getCfnResourceType

public java.lang.String getCfnResourceType()

AWS resource type.

getUpdatedProperites

protected java.util.Map<java.lang.String,java.lang.Object> getUpdatedProperites()

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.