Show / Hide Table of Contents

Class CfnResource

Represents a CloudFormation resource.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnSkill
CfnAnalyzer
CfnCertificate
CfnCertificateAuthority
CfnCertificateAuthorityActivation
CfnBroker
CfnConfiguration
CfnConfigurationAssociation
CfnApp
CfnBranch
CfnDomain
CfnAccount
CfnApiKey
CfnApiMappingV2
CfnApiV2
CfnAuthorizer
CfnAuthorizerV2
CfnBasePathMapping
CfnClientCertificate
CfnDeployment
CfnDeploymentV2
CfnDocumentationPart
CfnDocumentationVersion
CfnDomainName
CfnDomainNameV2
CfnGatewayResponse
CfnIntegrationResponseV2
CfnIntegrationV2
CfnMethod
CfnModel
CfnModelV2
CfnRequestValidator
CfnResource
CfnRestApi
CfnRouteResponseV2
CfnRouteV2
CfnStage
CfnStageV2
CfnUsagePlan
CfnUsagePlanKey
CfnVpcLink
CfnApi
CfnApiGatewayManagedOverrides
CfnApiMapping
CfnAuthorizer
CfnDeployment
CfnDomainName
CfnIntegration
CfnIntegrationResponse
CfnModel
CfnRoute
CfnRouteResponse
CfnStage
CfnVpcLink
CfnApplication
CfnConfigurationProfile
CfnDeployment
CfnDeploymentStrategy
CfnEnvironment
CfnHostedConfigurationVersion
CfnConnectorProfile
CfnFlow
CfnScalableTarget
CfnScalingPolicy
CfnApplication
CfnGatewayRoute
CfnMesh
CfnRoute
CfnVirtualGateway
CfnVirtualNode
CfnVirtualRouter
CfnVirtualService
CfnDirectoryConfig
CfnFleet
CfnImageBuilder
CfnStack
CfnStackFleetAssociation
CfnStackUserAssociation
CfnUser
CfnApiCache
CfnApiKey
CfnDataSource
CfnFunctionConfiguration
CfnGraphQLApi
CfnGraphQLSchema
CfnResolver
CfnDataCatalog
CfnNamedQuery
CfnWorkGroup
CfnAssessment
CfnAutoScalingGroup
CfnLaunchConfiguration
CfnLifecycleHook
CfnScalingPolicy
CfnScheduledAction
CfnScalingPlan
CfnBackupPlan
CfnBackupSelection
CfnBackupVault
CfnComputeEnvironment
CfnJobDefinition
CfnJobQueue
CfnBudget
CfnKeyspace
CfnTable
CfnAnomalyMonitor
CfnAnomalySubscription
CfnCostCategory
CfnAccount
CfnCertificate
CfnSlackChannelConfiguration
CfnEnvironmentEC2
CfnCustomResource
CfnMacro
CfnModuleDefaultVersion
CfnModuleVersion
CfnResourceDefaultVersion
CfnResourceVersion
CfnStack
CfnStackSet
CfnWaitCondition
CfnWaitConditionHandle
CfnCachePolicy
CfnCloudFrontOriginAccessIdentity
CfnDistribution
CfnKeyGroup
CfnOriginRequestPolicy
CfnPublicKey
CfnRealtimeLogConfig
CfnStreamingDistribution
CfnTrail
CfnAlarm
CfnAnomalyDetector
CfnCompositeAlarm
CfnDashboard
CfnInsightRule
CfnMetricStream
CfnDomain
CfnRepository
CfnProject
CfnReportGroup
CfnSourceCredential
CfnRepository
CfnApplication
CfnDeploymentConfig
CfnDeploymentGroup
CfnProfilingGroup
CfnRepositoryAssociation
CfnCustomActionType
CfnPipeline
CfnWebhook
CfnGitHubRepository
CfnConnection
CfnNotificationRule
CfnIdentityPool
CfnIdentityPoolRoleAttachment
CfnUserPool
CfnUserPoolClient
CfnUserPoolDomain
CfnUserPoolGroup
CfnUserPoolIdentityProvider
CfnUserPoolResourceServer
CfnUserPoolRiskConfigurationAttachment
CfnUserPoolUICustomizationAttachment
CfnUserPoolUser
CfnUserPoolUserToGroupAttachment
CfnAggregationAuthorization
CfnConfigRule
CfnConfigurationAggregator
CfnConfigurationRecorder
CfnConformancePack
CfnDeliveryChannel
CfnOrganizationConfigRule
CfnOrganizationConformancePack
CfnRemediationConfiguration
CfnStoredQuery
CfnDataset
CfnJob
CfnProject
CfnRecipe
CfnSchedule
CfnPipeline
CfnAgent
CfnLocationEFS
CfnLocationFSxWindows
CfnLocationNFS
CfnLocationObjectStorage
CfnLocationS3
CfnLocationSMB
CfnTask
CfnCluster
CfnParameterGroup
CfnSubnetGroup
CfnGraph
CfnMemberInvitation
CfnNotificationChannel
CfnResourceCollection
CfnMicrosoftAD
CfnSimpleAD
CfnLifecyclePolicy
CfnCertificate
CfnEndpoint
CfnEventSubscription
CfnReplicationInstance
CfnReplicationSubnetGroup
CfnReplicationTask
CfnDBCluster
CfnDBClusterParameterGroup
CfnDBInstance
CfnDBSubnetGroup
CfnTable
CfnCapacityReservation
CfnCarrierGateway
CfnClientVpnAuthorizationRule
CfnClientVpnEndpoint
CfnClientVpnRoute
CfnClientVpnTargetNetworkAssociation
CfnCustomerGateway
CfnDHCPOptions
CfnEC2Fleet
CfnEgressOnlyInternetGateway
CfnEIP
CfnEIPAssociation
CfnFlowLog
CfnGatewayRouteTableAssociation
CfnHost
CfnInstance
CfnInternetGateway
CfnLaunchTemplate
CfnLocalGatewayRoute
CfnLocalGatewayRouteTableVPCAssociation
CfnNatGateway
CfnNetworkAcl
CfnNetworkAclEntry
CfnNetworkInsightsAnalysis
CfnNetworkInsightsPath
CfnNetworkInterface
CfnNetworkInterfaceAttachment
CfnNetworkInterfacePermission
CfnPlacementGroup
CfnPrefixList
CfnRoute
CfnRouteTable
CfnSecurityGroup
CfnSecurityGroupEgress
CfnSecurityGroupIngress
CfnSpotFleet
CfnSubnet
CfnSubnetCidrBlock
CfnSubnetNetworkAclAssociation
CfnSubnetRouteTableAssociation
CfnTrafficMirrorFilter
CfnTrafficMirrorFilterRule
CfnTrafficMirrorSession
CfnTrafficMirrorTarget
CfnTransitGateway
CfnTransitGatewayAttachment
CfnTransitGatewayConnect
CfnTransitGatewayMulticastDomain
CfnTransitGatewayMulticastDomainAssociation
CfnTransitGatewayMulticastGroupMember
CfnTransitGatewayMulticastGroupSource
CfnTransitGatewayRoute
CfnTransitGatewayRouteTable
CfnTransitGatewayRouteTableAssociation
CfnTransitGatewayRouteTablePropagation
CfnVolume
CfnVolumeAttachment
CfnVPC
CfnVPCCidrBlock
CfnVPCDHCPOptionsAssociation
CfnVPCEndpoint
CfnVPCEndpointConnectionNotification
CfnVPCEndpointService
CfnVPCEndpointServicePermissions
CfnVPCGatewayAttachment
CfnVPCPeeringConnection
CfnVPNConnection
CfnVPNConnectionRoute
CfnVPNGateway
CfnVPNGatewayRoutePropagation
CfnPublicRepository
CfnRegistryPolicy
CfnReplicationConfiguration
CfnRepository
CfnCapacityProvider
CfnCluster
CfnClusterCapacityProviderAssociations
CfnPrimaryTaskSet
CfnService
CfnTaskDefinition
CfnTaskSet
CfnAccessPoint
CfnFileSystem
CfnMountTarget
CfnAddon
CfnCluster
CfnFargateProfile
CfnNodegroup
CfnAddon
CfnCluster
CfnFargateProfile
CfnNodegroup
CfnCacheCluster
CfnGlobalReplicationGroup
CfnParameterGroup
CfnReplicationGroup
CfnSecurityGroup
CfnSecurityGroupIngress
CfnSubnetGroup
CfnUser
CfnUserGroup
CfnApplication
CfnApplicationVersion
CfnConfigurationTemplate
CfnEnvironment
CfnLoadBalancer
CfnListener
CfnListenerCertificate
CfnListenerRule
CfnLoadBalancer
CfnTargetGroup
CfnDomain
CfnCluster
CfnInstanceFleetConfig
CfnInstanceGroupConfig
CfnSecurityConfiguration
CfnStep
CfnStudio
CfnStudioSessionMapping
CfnVirtualCluster
CfnApiDestination
CfnArchive
CfnConnection
CfnEventBus
CfnEventBusPolicy
CfnRule
CfnDiscoverer
CfnRegistry
CfnRegistryPolicy
CfnSchema
CfnExperimentTemplate
CfnNotificationChannel
CfnPolicy
CfnFileSystem
CfnAlias
CfnBuild
CfnFleet
CfnGameServerGroup
CfnGameSessionQueue
CfnMatchmakingConfiguration
CfnMatchmakingRuleSet
CfnScript
CfnAccelerator
CfnEndpointGroup
CfnListener
CfnClassifier
CfnConnection
CfnCrawler
CfnDatabase
CfnDataCatalogEncryptionSettings
CfnDevEndpoint
CfnJob
CfnMLTransform
CfnPartition
CfnRegistry
CfnSchema
CfnSchemaVersion
CfnSchemaVersionMetadata
CfnSecurityConfiguration
CfnTable
CfnTrigger
CfnWorkflow
CfnConnectorDefinition
CfnConnectorDefinitionVersion
CfnCoreDefinition
CfnCoreDefinitionVersion
CfnDeviceDefinition
CfnDeviceDefinitionVersion
CfnFunctionDefinition
CfnFunctionDefinitionVersion
CfnGroup
CfnGroupVersion
CfnLoggerDefinition
CfnLoggerDefinitionVersion
CfnResourceDefinition
CfnResourceDefinitionVersion
CfnSubscriptionDefinition
CfnSubscriptionDefinitionVersion
CfnComponentVersion
CfnDetector
CfnFilter
CfnIPSet
CfnMaster
CfnMember
CfnThreatIntelSet
CfnAccessKey
CfnGroup
CfnInstanceProfile
CfnManagedPolicy
CfnOIDCProvider
CfnPolicy
CfnRole
CfnSAMLProvider
CfnServerCertificate
CfnServiceLinkedRole
CfnUser
CfnUserToGroupAddition
CfnVirtualMFADevice
CfnComponent
CfnContainerRecipe
CfnDistributionConfiguration
CfnImage
CfnImagePipeline
CfnImageRecipe
CfnInfrastructureConfiguration
CfnAssessmentTarget
CfnAssessmentTemplate
CfnResourceGroup
CfnAccountAuditConfiguration
CfnAuthorizer
CfnCertificate
CfnCustomMetric
CfnDimension
CfnDomainConfiguration
CfnMitigationAction
CfnPolicy
CfnPolicyPrincipalAttachment
CfnProvisioningTemplate
CfnScheduledAudit
CfnSecurityProfile
CfnThing
CfnThingPrincipalAttachment
CfnTopicRule
CfnTopicRuleDestination
CfnDevice
CfnPlacement
CfnProject
CfnChannel
CfnDataset
CfnDatastore
CfnPipeline
CfnDetectorModel
CfnInput
CfnAccessPolicy
CfnAsset
CfnAssetModel
CfnDashboard
CfnGateway
CfnPortal
CfnProject
CfnFlowTemplate
CfnDestination
CfnDeviceProfile
CfnServiceProfile
CfnWirelessDevice
CfnWirelessGateway
CfnChannel
CfnPlaybackKeyPair
CfnStreamKey
CfnDataSource
CfnFaq
CfnIndex
CfnStream
CfnStreamConsumer
CfnApplication
CfnApplicationCloudWatchLoggingOptionV2
CfnApplicationOutput
CfnApplicationOutputV2
CfnApplicationReferenceDataSource
CfnApplicationReferenceDataSourceV2
CfnApplicationV2
CfnDeliveryStream
CfnAlias
CfnKey
CfnDataLakeSettings
CfnPermissions
CfnResource
CfnAlias
CfnCodeSigningConfig
CfnEventInvokeConfig
CfnEventSourceMapping
CfnFunction
CfnLayerVersion
CfnLayerVersionPermission
CfnPermission
CfnVersion
CfnGrant
CfnLicense
CfnDestination
CfnLogGroup
CfnLogStream
CfnMetricFilter
CfnSubscriptionFilter
CfnProject
CfnCustomDataIdentifier
CfnFindingsFilter
CfnSession
CfnMember
CfnNode
CfnFlow
CfnFlowEntitlement
CfnFlowOutput
CfnFlowSource
CfnFlowVpcInterface
CfnJobTemplate
CfnPreset
CfnQueue
CfnChannel
CfnInput
CfnInputSecurityGroup
CfnAsset
CfnChannel
CfnOriginEndpoint
CfnPackagingConfiguration
CfnPackagingGroup
CfnContainer
CfnCluster
CfnEnvironment
CfnDBCluster
CfnDBClusterParameterGroup
CfnDBInstance
CfnDBParameterGroup
CfnDBSubnetGroup
CfnFirewall
CfnFirewallPolicy
CfnLoggingConfiguration
CfnRuleGroup
CfnCustomerGatewayAssociation
CfnDevice
CfnGlobalNetwork
CfnLink
CfnLinkAssociation
CfnSite
CfnTransitGatewayRegistration
CfnApp
CfnElasticLoadBalancerAttachment
CfnInstance
CfnLayer
CfnStack
CfnUserProfile
CfnVolume
CfnServer
CfnADMChannel
CfnAPNSChannel
CfnAPNSSandboxChannel
CfnAPNSVoipChannel
CfnAPNSVoipSandboxChannel
CfnApp
CfnApplicationSettings
CfnBaiduChannel
CfnCampaign
CfnEmailChannel
CfnEmailTemplate
CfnEventStream
CfnGCMChannel
CfnPushTemplate
CfnSegment
CfnSMSChannel
CfnSmsTemplate
CfnVoiceChannel
CfnConfigurationSet
CfnConfigurationSetEventDestination
CfnDedicatedIpPool
CfnIdentity
CfnLedger
CfnStream
CfnAnalysis
CfnDashboard
CfnTemplate
CfnTheme
CfnResourceShare
CfnDBCluster
CfnDBClusterParameterGroup
CfnDBInstance
CfnDBParameterGroup
CfnDBProxy
CfnDBProxyEndpoint
CfnDBProxyTargetGroup
CfnDBSecurityGroup
CfnDBSecurityGroupIngress
CfnDBSubnetGroup
CfnEventSubscription
CfnGlobalCluster
CfnOptionGroup
CfnCluster
CfnClusterParameterGroup
CfnClusterSecurityGroup
CfnClusterSecurityGroupIngress
CfnClusterSubnetGroup
CfnGroup
CfnFleet
CfnRobot
CfnRobotApplication
CfnRobotApplicationVersion
CfnSimulationApplication
CfnSimulationApplicationVersion
CfnDNSSEC
CfnHealthCheck
CfnHostedZone
CfnKeySigningKey
CfnRecordSet
CfnRecordSetGroup
CfnResolverDNSSECConfig
CfnResolverEndpoint
CfnResolverQueryLoggingConfig
CfnResolverQueryLoggingConfigAssociation
CfnResolverRule
CfnResolverRuleAssociation
CfnAccessPoint
CfnBucket
CfnBucketPolicy
CfnStorageLens
CfnAccessPoint
CfnAccessPointPolicy
CfnAccessPoint
CfnBucket
CfnBucketPolicy
CfnEndpoint
CfnApp
CfnAppImageConfig
CfnCodeRepository
CfnDataQualityJobDefinition
CfnDevice
CfnDeviceFleet
CfnDomain
CfnEndpoint
CfnEndpointConfig
CfnFeatureGroup
CfnImage
CfnImageVersion
CfnModel
CfnModelBiasJobDefinition
CfnModelExplainabilityJobDefinition
CfnModelPackageGroup
CfnModelQualityJobDefinition
CfnMonitoringSchedule
CfnNotebookInstance
CfnNotebookInstanceLifecycleConfig
CfnPipeline
CfnProject
CfnUserProfile
CfnWorkteam
CfnApi
CfnApplication
CfnFunction
CfnLayerVersion
CfnSimpleTable
CfnStateMachine
CfnDomain
CfnResourcePolicy
CfnRotationSchedule
CfnSecret
CfnSecretTargetAttachment
CfnHub
CfnAcceptedPortfolioShare
CfnCloudFormationProduct
CfnCloudFormationProvisionedProduct
CfnLaunchNotificationConstraint
CfnLaunchRoleConstraint
CfnLaunchTemplateConstraint
CfnPortfolio
CfnPortfolioPrincipalAssociation
CfnPortfolioProductAssociation
CfnPortfolioShare
CfnResourceUpdateConstraint
CfnServiceAction
CfnServiceActionAssociation
CfnStackSetConstraint
CfnTagOption
CfnTagOptionAssociation
CfnApplication
CfnAttributeGroup
CfnAttributeGroupAssociation
CfnResourceAssociation
CfnHttpNamespace
CfnInstance
CfnPrivateDnsNamespace
CfnPublicDnsNamespace
CfnService
CfnConfigurationSet
CfnConfigurationSetEventDestination
CfnReceiptFilter
CfnReceiptRule
CfnReceiptRuleSet
CfnTemplate
CfnProfilePermission
CfnSigningProfile
CfnSubscription
CfnTopic
CfnTopicPolicy
CfnQueue
CfnQueuePolicy
CfnAssociation
CfnDocument
CfnMaintenanceWindow
CfnMaintenanceWindowTarget
CfnMaintenanceWindowTask
CfnParameter
CfnPatchBaseline
CfnResourceDataSync
CfnAssignment
CfnInstanceAccessControlAttributeConfiguration
CfnPermissionSet
CfnActivity
CfnStateMachine
CfnCanary
CfnDatabase
CfnTable
CfnServer
CfnUser
CfnByteMatchSet
CfnIPSet
CfnRule
CfnSizeConstraintSet
CfnSqlInjectionMatchSet
CfnWebACL
CfnXssMatchSet
CfnByteMatchSet
CfnGeoMatchSet
CfnIPSet
CfnRateBasedRule
CfnRegexPatternSet
CfnRule
CfnSizeConstraintSet
CfnSqlInjectionMatchSet
CfnWebACL
CfnWebACLAssociation
CfnXssMatchSet
CfnIPSet
CfnRegexPatternSet
CfnRuleGroup
CfnWebACL
CfnWebACLAssociation
CfnConnectionAlias
CfnWorkspace
CfnCustomResource
CfnMacro
CfnModuleDefaultVersion
CfnModuleVersion
CfnResourceDefaultVersion
CfnResourceVersion
CfnStack
CfnStackSet
CfnWaitCondition
CfnWaitConditionHandle
Implements
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class CfnResource : CfnRefElement, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class CfnResource
    Inherits CfnRefElement
    Implements IConstruct, IConstruct, IDependable

Synopsis

Constructors

CfnResource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnResource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

CfnResource(Construct, String, ICfnResourceProps)

Creates a resource construct.

Properties

CfnOptions

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

CfnProperties
CfnResourceType

AWS resource type.

UpdatedProperites

Return properties modified after initiation.

Methods

AddDeletionOverride(String)

Syntactic sugar for addOverride(path, undefined).

AddDependsOn(CfnResource)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

AddMetadata(String, Object)

Add a value to the CloudFormation Resource Metadata.

AddOverride(String, Object)

Adds an override to the synthesized CloudFormation resource.

AddPropertyDeletionOverride(String)

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

AddPropertyOverride(String, Object)

Adds an override to a resource property.

ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

GetAtt(String)

Returns a token for an runtime attribute of this resource.

GetMetadata(String)

Retrieve a value value from the CloudFormation Resource Metadata.

IsCfnResource(IConstruct)

Check whether the given construct is a CfnResource.

RenderProperties(IDictionary<String, Object>)
ShouldSynthesize()

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

ToString()

Returns a string representation of this construct.

ValidateProperties(Object)

Constructors

CfnResource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnResource(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnResource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnResource(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnResource(Construct, String, ICfnResourceProps)

Creates a resource construct.

public CfnResource(Construct scope, string id, ICfnResourceProps props)
Parameters
scope Constructs.Construct
id System.String
props ICfnResourceProps

Properties

CfnOptions

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

public virtual ICfnResourceOptions CfnOptions { get; }
Property Value

ICfnResourceOptions

CfnProperties

protected virtual IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

CfnResourceType

AWS resource type.

public virtual string CfnResourceType { get; }
Property Value

System.String

UpdatedProperites

Return properties modified after initiation.

protected virtual IDictionary<string, object> UpdatedProperites { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

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

Methods

AddDeletionOverride(String)

Syntactic sugar for addOverride(path, undefined).

public virtual void AddDeletionOverride(string path)
Parameters
path System.String

The path of the value to delete.

AddDependsOn(CfnResource)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

public virtual void AddDependsOn(CfnResource target)
Parameters
target CfnResource
Remarks

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

AddMetadata(String, Object)

Add a value to the CloudFormation Resource Metadata.

public virtual void AddMetadata(string key, object value)
Parameters
key System.String
value System.Object
Remarks

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

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(String, Object)

Adds an override to the synthesized CloudFormation resource.

public virtual void AddOverride(string path, object value)
Parameters
path System.String
  • The path of the property, you can use dot notation to override values in complex types.
value System.Object
  • The value.
Remarks

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 </code>. In most programming languages you will need to write this as "\." because the </code> itself will need to be escaped.

For example,

// Example automatically generated. See https://github.com/aws/jsii/issues/826
cfnResource.AddOverride("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", new [] { "myattribute" });
cfnResource.AddOverride("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE");

would add the overrides

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

AddPropertyDeletionOverride(String)

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

public virtual void AddPropertyDeletionOverride(string propertyPath)
Parameters
propertyPath System.String

The path to the property.

AddPropertyOverride(String, Object)

Adds an override to a resource property.

public virtual void AddPropertyOverride(string propertyPath, object value)
Parameters
propertyPath System.String

The path of the property.

value System.Object

The value.

Remarks

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

ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

public virtual void ApplyRemovalPolicy(Nullable<RemovalPolicy> policy = null, IRemovalPolicyOptions options = null)
Parameters
policy System.Nullable<RemovalPolicy>
options IRemovalPolicyOptions

GetAtt(String)

Returns a token for an runtime attribute of this resource.

public virtual Reference GetAtt(string attributeName)
Parameters
attributeName System.String

The name of the attribute.

Returns

Reference

Remarks

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

GetMetadata(String)

Retrieve a value value from the CloudFormation Resource Metadata.

public virtual object GetMetadata(string key)
Parameters
key System.String
Returns

System.Object

Remarks

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

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.

IsCfnResource(IConstruct)

Check whether the given construct is a CfnResource.

public static bool IsCfnResource(IConstruct construct)
Parameters
construct Constructs.IConstruct
Returns

System.Boolean

RenderProperties(IDictionary<String, Object>)

protected virtual IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

ShouldSynthesize()

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

protected virtual bool ShouldSynthesize()
Returns

System.Boolean

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

ToString()

Returns a string representation of this construct.

public override string ToString()
Returns

System.String

a string representation of this resource

ValidateProperties(Object)

protected virtual void ValidateProperties(object properties)
Parameters
properties System.Object

Implements

IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX