awscdk package - github.com/aws/aws-cdk-go/awscdk/v2 - Go Packages
Version 2 of the AWS Cloud Development Kit library
- func App_IsApp(obj interface{}) *bool
- func App_IsConstruct(x interface{}) *bool
- func App_IsStage(x interface{}) *bool
- func Arn_ExtractResourceName(arn *string, resourceType *string) *string
- func Arn_Format(components *ArnComponents, stack Stack) *string
- func AspectPriority_DEFAULT() *float64
- func AspectPriority_MUTATING() *float64
- func AspectPriority_READONLY() *float64
- func AssetStaging_BUNDLING_INPUT_DIR() *string
- func AssetStaging_BUNDLING_OUTPUT_DIR() *string
- func AssetStaging_ClearAssetHashCache()
- func AssetStaging_IsConstruct(x interface{}) *bool
- func Aws_ACCOUNT_ID() *string
- func Aws_NOTIFICATION_ARNS() *[]*string
- func Aws_NO_VALUE() *string
- func Aws_PARTITION() *string
- func Aws_REGION() *string
- func Aws_STACK_ID() *string
- func Aws_STACK_NAME() *string
- func Aws_URL_SUFFIX() *string
- func BootstraplessSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string
- func BootstraplessSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string
- func BootstraplessSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string
- func BootstraplessSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string
- func BootstraplessSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string
- func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string
- func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string
- func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string
- func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string
- func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string
- func BootstraplessSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string
- func BootstraplessSynthesizer_DEFAULT_QUALIFIER() *string
- func CfnCodeDeployBlueGreenHook_IsCfnElement(x interface{}) *bool
- func CfnCodeDeployBlueGreenHook_IsConstruct(x interface{}) *bool
- func CfnCondition_IsCfnElement(x interface{}) *bool
- func CfnCondition_IsConstruct(x interface{}) *bool
- func CfnCustomResource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomResource_IsCfnCustomResource(x interface{}) *bool
- func CfnCustomResource_IsCfnElement(x interface{}) *bool
- func CfnCustomResource_IsCfnResource(x interface{}) *bool
- func CfnCustomResource_IsConstruct(x interface{}) *bool
- func CfnElement_IsCfnElement(x interface{}) *bool
- func CfnElement_IsConstruct(x interface{}) *bool
- func CfnGuardHook_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGuardHook_IsCfnElement(x interface{}) *bool
- func CfnGuardHook_IsCfnGuardHook(x interface{}) *bool
- func CfnGuardHook_IsCfnResource(x interface{}) *bool
- func CfnGuardHook_IsConstruct(x interface{}) *bool
- func CfnHookDefaultVersion_ArnForHookDefaultVersion(resource interfacesawscloudformation.IHookDefaultVersionRef) *string
- func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnHookDefaultVersion_IsCfnHookDefaultVersion(x interface{}) *bool
- func CfnHookDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnHookDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookTypeConfig_IsCfnElement(x interface{}) *bool
- func CfnHookTypeConfig_IsCfnHookTypeConfig(x interface{}) *bool
- func CfnHookTypeConfig_IsCfnResource(x interface{}) *bool
- func CfnHookTypeConfig_IsConstruct(x interface{}) *bool
- func CfnHookVersion_ArnForHookVersion(resource interfacesawscloudformation.IHookVersionRef) *string
- func CfnHookVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookVersion_IsCfnElement(x interface{}) *bool
- func CfnHookVersion_IsCfnHookVersion(x interface{}) *bool
- func CfnHookVersion_IsCfnResource(x interface{}) *bool
- func CfnHookVersion_IsConstruct(x interface{}) *bool
- func CfnHook_IsCfnElement(x interface{}) *bool
- func CfnHook_IsConstruct(x interface{}) *bool
- func CfnJson_IsConstruct(x interface{}) *bool
- func CfnLambdaHook_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLambdaHook_IsCfnElement(x interface{}) *bool
- func CfnLambdaHook_IsCfnLambdaHook(x interface{}) *bool
- func CfnLambdaHook_IsCfnResource(x interface{}) *bool
- func CfnLambdaHook_IsConstruct(x interface{}) *bool
- func CfnMacro_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMacro_IsCfnElement(x interface{}) *bool
- func CfnMacro_IsCfnMacro(x interface{}) *bool
- func CfnMacro_IsCfnResource(x interface{}) *bool
- func CfnMacro_IsConstruct(x interface{}) *bool
- func CfnMapping_IsCfnElement(x interface{}) *bool
- func CfnMapping_IsConstruct(x interface{}) *bool
- func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModuleDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnModuleDefaultVersion_IsCfnModuleDefaultVersion(x interface{}) *bool
- func CfnModuleDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnModuleDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnModuleVersion_ArnForModuleVersion(resource interfacesawscloudformation.IModuleVersionRef) *string
- func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModuleVersion_IsCfnElement(x interface{}) *bool
- func CfnModuleVersion_IsCfnModuleVersion(x interface{}) *bool
- func CfnModuleVersion_IsCfnResource(x interface{}) *bool
- func CfnModuleVersion_IsConstruct(x interface{}) *bool
- func CfnOutput_IsCfnElement(x interface{}) *bool
- func CfnOutput_IsConstruct(x interface{}) *bool
- func CfnParameter_IsCfnElement(x interface{}) *bool
- func CfnParameter_IsConstruct(x interface{}) *bool
- func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPublicTypeVersion_IsCfnElement(x interface{}) *bool
- func CfnPublicTypeVersion_IsCfnPublicTypeVersion(x interface{}) *bool
- func CfnPublicTypeVersion_IsCfnResource(x interface{}) *bool
- func CfnPublicTypeVersion_IsConstruct(x interface{}) *bool
- func CfnPublisher_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPublisher_IsCfnElement(x interface{}) *bool
- func CfnPublisher_IsCfnPublisher(x interface{}) *bool
- func CfnPublisher_IsCfnResource(x interface{}) *bool
- func CfnPublisher_IsConstruct(x interface{}) *bool
- func CfnRefElement_IsCfnElement(x interface{}) *bool
- func CfnRefElement_IsConstruct(x interface{}) *bool
- func CfnResourceDefaultVersion_ArnForResourceDefaultVersion(resource interfacesawscloudformation.IResourceDefaultVersionRef) *string
- func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnResourceDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnResourceDefaultVersion_IsCfnResourceDefaultVersion(x interface{}) *bool
- func CfnResourceDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnResourceVersion_ArnForResourceVersion(resource interfacesawscloudformation.IResourceVersionRef) *string
- func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceVersion_IsCfnElement(x interface{}) *bool
- func CfnResourceVersion_IsCfnResource(x interface{}) *bool
- func CfnResourceVersion_IsCfnResourceVersion(x interface{}) *bool
- func CfnResourceVersion_IsConstruct(x interface{}) *bool
- func CfnResource_IsCfnElement(x interface{}) *bool
- func CfnResource_IsCfnResource(x interface{}) *bool
- func CfnResource_IsConstruct(x interface{}) *bool
- func CfnRule_IsCfnElement(x interface{}) *bool
- func CfnRule_IsConstruct(x interface{}) *bool
- func CfnStackSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStackSet_IsCfnElement(x interface{}) *bool
- func CfnStackSet_IsCfnResource(x interface{}) *bool
- func CfnStackSet_IsCfnStackSet(x interface{}) *bool
- func CfnStackSet_IsConstruct(x interface{}) *bool
- func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStack_IsCfnElement(x interface{}) *bool
- func CfnStack_IsCfnResource(x interface{}) *bool
- func CfnStack_IsCfnStack(x interface{}) *bool
- func CfnStack_IsConstruct(x interface{}) *bool
- func CfnTypeActivation_ArnForTypeActivation(resource interfacesawscloudformation.ITypeActivationRef) *string
- func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTypeActivation_IsCfnElement(x interface{}) *bool
- func CfnTypeActivation_IsCfnResource(x interface{}) *bool
- func CfnTypeActivation_IsCfnTypeActivation(x interface{}) *bool
- func CfnTypeActivation_IsConstruct(x interface{}) *bool
- func CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWaitConditionHandle_IsCfnElement(x interface{}) *bool
- func CfnWaitConditionHandle_IsCfnResource(x interface{}) *bool
- func CfnWaitConditionHandle_IsCfnWaitConditionHandle(x interface{}) *bool
- func CfnWaitConditionHandle_IsConstruct(x interface{}) *bool
- func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWaitCondition_IsCfnElement(x interface{}) *bool
- func CfnWaitCondition_IsCfnResource(x interface{}) *bool
- func CfnWaitCondition_IsCfnWaitCondition(x interface{}) *bool
- func CfnWaitCondition_IsConstruct(x interface{}) *bool
- func CustomResourceProviderBase_IsConstruct(x interface{}) *bool
- func CustomResourceProvider_GetOrCreate(scope constructs.Construct, uniqueid *string, ...) *string
- func CustomResourceProvider_IsConstruct(x interface{}) *bool
- func CustomResource_IsConstruct(x interface{}) *bool
- func CustomResource_IsOwnedResource(construct constructs.IConstruct) *bool
- func CustomResource_IsResource(construct constructs.IConstruct) *bool
- func CustomResource_PROPERTY_INJECTION_ID() *string
- func DefaultStackSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string
- func DefaultStackSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string
- func DefaultStackSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string
- func DefaultStackSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string
- func DefaultStackSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string
- func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string
- func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string
- func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string
- func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string
- func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string
- func DefaultStackSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string
- func DefaultStackSynthesizer_DEFAULT_QUALIFIER() *string
- func DockerBuildSecret_FromSrc(src *string) *string
- func Errors_IsAssertionError(x interface{}) *bool
- func Errors_IsAssumptionError(x interface{}) *bool
- func Errors_IsCloudAssemblyError(x interface{}) *bool
- func Errors_IsConstructError(x interface{}) *bool
- func Errors_IsExecutionError(x interface{}) *bool
- func Errors_IsValidationError(x interface{}) *bool
- func FileSystem_CopyDirectory(srcDir *string, destDir *string, options *CopyOptions, rootDir *string)
- func FileSystem_Fingerprint(fileOrDirectory *string, options *FingerprintOptions) *string
- func FileSystem_IsEmpty(dir *string) *bool
- func FileSystem_Mkdtemp(prefix *string) *string
- func FileSystem_Rmrf(dirname *string)
- func FileSystem_Tmpdir() *string
- func Fn_Base64(data *string) *string
- func Fn_Cidr(ipBlock *string, count *float64, sizeMask *string) *[]*string
- func Fn_FindInMap(mapName *string, topLevelKey *string, secondLevelKey *string, ...) *string
- func Fn_GetAzs(region *string) *[]*string
- func Fn_ImportListValue(sharedValueToImport *string, assumedLength *float64, delimiter *string) *[]*string
- func Fn_ImportValue(sharedValueToImport *string) *string
- func Fn_Join(delimiter *string, listOfValues *[]*string) *string
- func Fn_Len(array interface{}) *float64
- func Fn_ParseDomainName(url *string) *string
- func Fn_Ref(logicalName *string) *string
- func Fn_RefAll(parameterType *string) *[]*string
- func Fn_Select(index *float64, array *[]*string) *string
- func Fn_Split(delimiter *string, source *string, assumedLength *float64) *[]*string
- func Fn_Sub(body *string, variables *map[string]*string) *string
- func Fn_ToJsonString(object interface{}) *string
- func Fn_ValueOf(parameterOrLogicalId *string, attribute *string) *string
- func Fn_ValueOfAll(parameterType *string, attribute *string) *[]*string
- func Lazy_List(producer IStableListProducer, options *LazyListValueOptions) *[]*string
- func Lazy_Number(producer IStableNumberProducer) *float64
- func Lazy_String(producer IStableStringProducer, options *LazyStringValueOptions) *string
- func Lazy_UncachedList(producer IListProducer, options *LazyListValueOptions) *[]*string
- func Lazy_UncachedNumber(producer INumberProducer) *float64
- func Lazy_UncachedString(producer IStringProducer, options *LazyStringValueOptions) *string
- func Names_NodeUniqueId(node constructs.Node) *string
- func Names_StackRelativeConstructPath(construct constructs.IConstruct) *string
- func Names_UniqueId(construct constructs.IConstruct) *string
- func Names_UniqueResourceName(construct constructs.IConstruct, options *UniqueResourceNameOptions) *string
- func NestedStack_IsConstruct(x interface{}) *bool
- func NestedStack_IsNestedStack(x interface{}) *bool
- func NestedStack_IsStack(x interface{}) *bool
- func NewApp_Override(a App, props *AppProps)
- func NewAspectApplication_Override(a AspectApplication, construct constructs.IConstruct, aspect IAspect, ...)
- func NewAspectPriority_Override(a AspectPriority)
- func NewAssetManifestBuilder_Override(a AssetManifestBuilder)
- func NewAssetStaging_Override(a AssetStaging, scope constructs.Construct, id *string, ...)
- func NewBootstraplessSynthesizer_Override(b BootstraplessSynthesizer, props *BootstraplessSynthesizerProps)
- func NewCfnCodeDeployBlueGreenHook_Override(c CfnCodeDeployBlueGreenHook, scope constructs.Construct, id *string, ...)
- func NewCfnCondition_Override(c CfnCondition, scope constructs.Construct, id *string, ...)
- func NewCfnCustomResource_Override(c CfnCustomResource, scope constructs.Construct, id *string, ...)
- func NewCfnDynamicReference_Override(c CfnDynamicReference, service CfnDynamicReferenceService, key *string)
- func NewCfnElement_Override(c CfnElement, scope constructs.Construct, id *string)
- func NewCfnGuardHook_Override(c CfnGuardHook, scope constructs.Construct, id *string, ...)
- func NewCfnHookDefaultVersion_Override(c CfnHookDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnHookTypeConfig_Override(c CfnHookTypeConfig, scope constructs.Construct, id *string, ...)
- func NewCfnHookVersion_Override(c CfnHookVersion, scope constructs.Construct, id *string, ...)
- func NewCfnHook_Override(c CfnHook, scope constructs.Construct, id *string, props *CfnHookProps)
- func NewCfnJson_Override(c CfnJson, scope constructs.Construct, id *string, props *CfnJsonProps)
- func NewCfnLambdaHook_Override(c CfnLambdaHook, scope constructs.Construct, id *string, ...)
- func NewCfnMacro_Override(c CfnMacro, scope constructs.Construct, id *string, props *CfnMacroProps)
- func NewCfnMapping_Override(c CfnMapping, scope constructs.Construct, id *string, props *CfnMappingProps)
- func NewCfnModuleDefaultVersion_Override(c CfnModuleDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnModuleVersion_Override(c CfnModuleVersion, scope constructs.Construct, id *string, ...)
- func NewCfnOutput_Override(c CfnOutput, scope constructs.Construct, id *string, props *CfnOutputProps)
- func NewCfnParameter_Override(c CfnParameter, scope constructs.Construct, id *string, ...)
- func NewCfnPublicTypeVersion_Override(c CfnPublicTypeVersion, scope constructs.Construct, id *string, ...)
- func NewCfnPublisher_Override(c CfnPublisher, scope constructs.Construct, id *string, ...)
- func NewCfnRefElement_Override(c CfnRefElement, scope constructs.Construct, id *string)
- func NewCfnResourceDefaultVersion_Override(c CfnResourceDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnResourceVersion_Override(c CfnResourceVersion, scope constructs.Construct, id *string, ...)
- func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)
- func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)
- func NewCfnStackSet_Override(c CfnStackSet, scope constructs.Construct, id *string, props *CfnStackSetProps)
- func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps)
- func NewCfnTypeActivation_Override(c CfnTypeActivation, scope constructs.Construct, id *string, ...)
- func NewCfnWaitConditionHandle_Override(c CfnWaitConditionHandle, scope constructs.Construct, id *string, ...)
- func NewCfnWaitCondition_Override(c CfnWaitCondition, scope constructs.Construct, id *string, ...)
- func NewCliCredentialsStackSynthesizer_Override(c CliCredentialsStackSynthesizer, props *CliCredentialsStackSynthesizerProps)
- func NewCustomResourceProviderBase_Override(c CustomResourceProviderBase, scope constructs.Construct, id *string, ...)
- func NewCustomResourceProvider_Override(c CustomResourceProvider, scope constructs.Construct, id *string, ...)
- func NewCustomResource_Override(c CustomResource, scope constructs.Construct, id *string, ...)
- func NewDefaultStackSynthesizer_Override(d DefaultStackSynthesizer, props *DefaultStackSynthesizerProps)
- func NewDefaultTokenResolver_Override(d DefaultTokenResolver, concat IFragmentConcatenator)
- func NewDockerBuildSecret_Override(d DockerBuildSecret)
- func NewDockerIgnoreStrategy_Override(d DockerIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
- func NewDockerImage_Override(d DockerImage, image *string, _imageHash *string)
- func NewErrors_Override(e Errors)
- func NewFileSystem_Override(f FileSystem)
- func NewGitIgnoreStrategy_Override(g GitIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
- func NewGlobIgnoreStrategy_Override(g GlobIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
- func NewIgnoreStrategy_Override(i IgnoreStrategy)
- func NewIntrinsic_Override(i Intrinsic, value interface{}, options *IntrinsicProps)
- func NewLegacyStackSynthesizer_Override(l LegacyStackSynthesizer)
- func NewNestedStackSynthesizer_Override(n NestedStackSynthesizer, parentDeployment IStackSynthesizer)
- func NewNestedStack_Override(n NestedStack, scope constructs.Construct, id *string, props *NestedStackProps)
- func NewReference_Override(r Reference, value interface{}, target constructs.IConstruct, ...)
- func NewRemoveTag_Override(r RemoveTag, key *string, props *TagProps)
- func NewResource_Override(r Resource, scope constructs.Construct, id *string, props *ResourceProps)
- func NewScopedAws_Override(s ScopedAws, scope constructs.Construct)
- func NewSecretValue_Override(s SecretValue, protectedValue interface{}, options *IntrinsicProps)
- func NewStackSynthesizer_Override(s StackSynthesizer)
- func NewStack_Override(s Stack, scope constructs.Construct, id *string, props *StackProps)
- func NewStage_Override(s Stage, scope constructs.Construct, id *string, props *StageProps)
- func NewStringConcat_Override(s StringConcat)
- func NewTagManager_Override(t TagManager, tagType TagType, resourceTypeName *string, ...)
- func NewTag_Override(t Tag, key *string, value *string, props *TagProps)
- func NewTokenizedStringFragments_Override(t TokenizedStringFragments)
- func NewTreeInspector_Override(t TreeInspector)
- func NewValidationResult_Override(v ValidationResult, errorMessage *string, results ValidationResults)
- func NewValidationResults_Override(v ValidationResults, results *[]ValidationResult)
- func PhysicalName_GENERATE_IF_NEEDED() *string
- func PropertyInjectors_HasPropertyInjectors(x interface{}) *bool
- func Reference_IsReference(x interface{}) *bool
- func Resource_IsConstruct(x interface{}) *bool
- func Resource_IsOwnedResource(construct constructs.IConstruct) *bool
- func Resource_IsResource(construct constructs.IConstruct) *bool
- func SecretValue_CfnDynamicReferenceKey(secretId *string, options *SecretsManagerSecretOptions) *string
- func SecretValue_IsSecretValue(x interface{}) *bool
- func Stack_IsConstruct(x interface{}) *bool
- func Stack_IsStack(x interface{}) *bool
- func Stage_IsConstruct(x interface{}) *bool
- func Stage_IsStage(x interface{}) *bool
- func TagManager_IsTaggable(construct interface{}) *bool
- func TagManager_IsTaggableV2(construct interface{}) *bool
- func Token_AsList(value interface{}, options *EncodingOptions) *[]*string
- func Token_AsNumber(value interface{}) *float64
- func Token_AsString(value interface{}, options *EncodingOptions) *string
- func Token_IsResolved(obj interface{}) *bool
- func Token_IsUnresolved(obj interface{}) *bool
- func Tokenization_IsResolvable(obj interface{}) *bool
- func Tokenization_Resolve(obj interface{}, options *ResolveOptions) interface{}
- func Tokenization_StringifyNumber(x *float64) *string
- type AWSEventMetadataProps
- type AddDockerImageAssetOptions
- type AddFileAssetOptions
- type Annotations
- type App
- type AppProps
- type Arn
- type ArnComponents
- type ArnFormat
- type AspectApplication
- type AspectOptions
- type AspectPriority
- type Aspects
- type AssetHashType
- type AssetManifestBuilder
- type AssetManifestDockerImageDestination
- type AssetManifestFileDestination
- type AssetOptions
- type AssetStaging
- type AssetStagingProps
- type Aws
- type BootstraplessSynthesizer
- type BootstraplessSynthesizerProps
- type BundlingFileAccess
- type BundlingOptions
- type BundlingOutput
- type CfnAutoScalingReplacingUpdate
- type CfnAutoScalingRollingUpdate
- type CfnAutoScalingScheduledAction
- type CfnCapabilities
- type CfnCodeDeployBlueGreenAdditionalOptions
- type CfnCodeDeployBlueGreenApplication
- type CfnCodeDeployBlueGreenApplicationTarget
- type CfnCodeDeployBlueGreenEcsAttributes
- type CfnCodeDeployBlueGreenHook
- type CfnCodeDeployBlueGreenHookProps
- type CfnCodeDeployBlueGreenLifecycleEventHooks
- type CfnCodeDeployLambdaAliasUpdate
- type CfnCondition
- type CfnConditionProps
- type CfnCreationPolicy
- type CfnCustomResource
- type CfnCustomResourceProps
- type CfnDeletionPolicy
- type CfnDynamicReference
- type CfnDynamicReferenceProps
- type CfnDynamicReferenceService
- type CfnElement
- type CfnGuardHook
- type CfnGuardHookProps
- type CfnGuardHook_HookTargetProperty
- type CfnGuardHook_OptionsProperty
- type CfnGuardHook_S3LocationProperty
- type CfnGuardHook_StackFiltersProperty
- type CfnGuardHook_StackNamesProperty
- type CfnGuardHook_StackRolesProperty
- type CfnGuardHook_TargetFiltersProperty
- type CfnHook
- type CfnHookDefaultVersion
- type CfnHookDefaultVersionProps
- type CfnHookProps
- type CfnHookTypeConfig
- type CfnHookTypeConfigProps
- type CfnHookVersion
- type CfnHookVersionProps
- type CfnHookVersion_LoggingConfigProperty
- type CfnJson
- type CfnJsonProps
- type CfnLambdaHook
- type CfnLambdaHookProps
- type CfnLambdaHook_HookTargetProperty
- type CfnLambdaHook_StackFiltersProperty
- type CfnLambdaHook_StackNamesProperty
- type CfnLambdaHook_StackRolesProperty
- type CfnLambdaHook_TargetFiltersProperty
- type CfnMacro
- type CfnMacroProps
- type CfnMapping
- type CfnMappingProps
- type CfnModuleDefaultVersion
- type CfnModuleDefaultVersionProps
- type CfnModuleVersion
- type CfnModuleVersionProps
- type CfnOutput
- type CfnOutputProps
- type CfnParameter
- type CfnParameterProps
- type CfnPublicTypeVersion
- type CfnPublicTypeVersionProps
- type CfnPublisher
- type CfnPublisherProps
- type CfnRefElement
- type CfnResource
- type CfnResourceAutoScalingCreationPolicy
- type CfnResourceDefaultVersion
- type CfnResourceDefaultVersionProps
- type CfnResourceProps
- type CfnResourceSignal
- type CfnResourceVersion
- type CfnResourceVersionProps
- type CfnResourceVersion_LoggingConfigProperty
- type CfnRule
- type CfnRuleAssertion
- type CfnRuleProps
- type CfnStack
- type CfnStackProps
- type CfnStackSet
- type CfnStackSetProps
- type CfnStackSet_AutoDeploymentProperty
- type CfnStackSet_DeploymentTargetsProperty
- type CfnStackSet_ManagedExecutionProperty
- type CfnStackSet_OperationPreferencesProperty
- type CfnStackSet_ParameterProperty
- type CfnStackSet_StackInstancesProperty
- type CfnStack_OutputProperty
- type CfnTag
- type CfnTrafficRoute
- type CfnTrafficRouting
- type CfnTrafficRoutingConfig
- type CfnTrafficRoutingTimeBasedCanary
- type CfnTrafficRoutingTimeBasedLinear
- type CfnTrafficRoutingType
- type CfnTypeActivation
- type CfnTypeActivationProps
- type CfnTypeActivation_LoggingConfigProperty
- type CfnUpdatePolicy
- type CfnWaitCondition
- type CfnWaitConditionHandle
- type CfnWaitConditionHandleProps
- type CfnWaitConditionProps
- type CliCredentialsStackSynthesizer
- type CliCredentialsStackSynthesizerProps
- type ContextProvider
- type CopyOptions
- type CustomResource
- type CustomResourceProps
- type CustomResourceProvider
- type CustomResourceProviderBase
- type CustomResourceProviderBaseProps
- type CustomResourceProviderOptions
- type CustomResourceProviderProps
- type CustomResourceProviderRuntime
- type DefaultStackSynthesizer
- type DefaultStackSynthesizerProps
- type DefaultTokenResolver
- type DockerBuildOptions
- type DockerBuildSecret
- type DockerCacheOption
- type DockerIgnoreStrategy
- func DockerIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
- func GitIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
- func GlobIgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
- func IgnoreStrategy_Docker(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
- func NewDockerIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
- type DockerImage
- type DockerImageAssetLocation
- type DockerImageAssetSource
- type DockerRunOptions
- type DockerVolume
- type DockerVolumeConsistency
- type Duration
- type EncodingOptions
- type Environment
- type Errors
- type Expiration
- type ExportValueOptions
- type FeatureFlags
- type FileAssetLocation
- type FileAssetPackaging
- type FileAssetSource
- type FileCopyOptions
- type FileFingerprintOptions
- type FileSystem
- type FingerprintOptions
- type Fn
- type GetContextKeyOptions
- type GetContextKeyResult
- type GetContextValueOptions
- type GetContextValueResult
- type GitIgnoreStrategy
- func DockerIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
- func GitIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
- func GlobIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
- func IgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
- func NewGitIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
- type GlobIgnoreStrategy
- func DockerIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
- func GitIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
- func GlobIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
- func IgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
- func NewGlobIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
- type IAnyProducer
- type IAspect
- type IAsset
- type IBoundStackSynthesizer
- type ICfnConditionExpression
- type ICfnResourceOptions
- type ICfnRuleConditionExpression
- func Fn_ConditionAnd(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression
- func Fn_ConditionContains(listOfStrings *[]*string, value *string) ICfnRuleConditionExpression
- func Fn_ConditionEachMemberEquals(listOfStrings *[]*string, value *string) ICfnRuleConditionExpression
- func Fn_ConditionEachMemberIn(stringsToCheck *[]*string, stringsToMatch *[]*string) ICfnRuleConditionExpression
- func Fn_ConditionEquals(lhs interface{}, rhs interface{}) ICfnRuleConditionExpression
- func Fn_ConditionIf(conditionId *string, valueIfTrue interface{}, valueIfFalse interface{}) ICfnRuleConditionExpression
- func Fn_ConditionNot(condition ICfnConditionExpression) ICfnRuleConditionExpression
- func Fn_ConditionOr(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression
- type IFragmentConcatenator
- type IInspectable
- type IListProducer
- type ILocalBundling
- type INumberProducer
- type IPolicyValidationContextBeta1
- type IPolicyValidationPluginBeta1
- type IPostProcessor
- type IPropertyInjector
- type IResolvable
- func Fn_GetAtt(logicalNameOfResource *string, attributeName *string) IResolvable
- func Fn_Transform(macroName *string, parameters *map[string]interface{}) IResolvable
- func Lazy_Any(producer IStableAnyProducer, options *LazyAnyValueOptions) IResolvable
- func Lazy_UncachedAny(producer IAnyProducer, options *LazyAnyValueOptions) IResolvable
- func Token_AsAny(value interface{}) IResolvable
- func Tokenization_Reverse(x interface{}, options *ReverseOptions) IResolvable
- func Tokenization_ReverseCompleteString(s *string) IResolvable
- func Tokenization_ReverseList(l *[]*string) IResolvable
- func Tokenization_ReverseNumber(n *float64) IResolvable
- type IResolveContext
- type IResource
- type IReusableStackSynthesizer
- type IStableAnyProducer
- type IStableListProducer
- type IStableNumberProducer
- type IStableStringProducer
- type IStackSynthesizer
- type IStringProducer
- type ISynthesisSession
- type ITaggable
- type ITaggableV2
- type ITemplateOptions
- type ITokenMapper
- type ITokenResolver
- type IgnoreMode
- type IgnoreStrategy
- func DockerIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
- func GitIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
- func GlobIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
- func IgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
- type InjectionContext
- type Intrinsic
- type IntrinsicProps
- type JsonNull
- type Lazy
- type LazyAnyValueOptions
- type LazyListValueOptions
- type LazyStringValueOptions
- type LegacyStackSynthesizer
- type MissingRemovalPolicies
- type Names
- type NestedStack
- type NestedStackProps
- type NestedStackSynthesizer
- type PermissionsBoundary
- type PermissionsBoundaryBindOptions
- type PhysicalName
- type PolicyValidationPluginReportBeta1
- type PolicyValidationReportStatusBeta1
- type PolicyViolatingResourceBeta1
- type PolicyViolationBeta1
- type PropertyInjectors
- type Reference
- type RemovalPolicies
- type RemovalPolicy
- type RemovalPolicyOptions
- type RemovalPolicyProps
- type RemoveTag
- type ResolutionTypeHint
- type ResolveChangeContextOptions
- type ResolveOptions
- type Resource
- type ResourceProps
- type ReverseOptions
- type RoleOptions
- type ScopedAws
- type SecretValue
- func NewSecretValue(protectedValue interface{}, options *IntrinsicProps) SecretValue
- func SecretValue_CfnDynamicReference(ref CfnDynamicReference) SecretValue
- func SecretValue_CfnParameter(param CfnParameter) SecretValue
- func SecretValue_PlainText(secret *string) SecretValue
- func SecretValue_ResourceAttribute(attr *string) SecretValue
- func SecretValue_SecretsManager(secretId *string, options *SecretsManagerSecretOptions) SecretValue
- func SecretValue_SsmSecure(parameterName *string, version *string) SecretValue
- func SecretValue_UnsafePlainText(secret *string) SecretValue
- type SecretsManagerSecretOptions
- type Size
- type SizeConversionOptions
- type SizeRoundingBehavior
- type Stack
- type StackProps
- type StackSynthesizer
- type Stage
- type StageProps
- type StageSynthesisOptions
- type StringConcat
- type SymlinkFollowMode
- type SynthesizeStackArtifactOptions
- type Tag
- type TagManager
- type TagManagerOptions
- type TagProps
- type TagType
- type Tags
- type TimeConversionOptions
- type TimeZone
- func TimeZone_AFRICA_ABIDJAN() TimeZone
- func TimeZone_AFRICA_ALGIERS() TimeZone
- func TimeZone_AFRICA_BISSAU() TimeZone
- func TimeZone_AFRICA_CAIRO() TimeZone
- func TimeZone_AFRICA_CASABLANCA() TimeZone
- func TimeZone_AFRICA_CEUTA() TimeZone
- func TimeZone_AFRICA_EL_AAIUN() TimeZone
- func TimeZone_AFRICA_JOHANNESBURG() TimeZone
- func TimeZone_AFRICA_JUBA() TimeZone
- func TimeZone_AFRICA_KHARTOUM() TimeZone
- func TimeZone_AFRICA_LAGOS() TimeZone
- func TimeZone_AFRICA_MAPUTO() TimeZone
- func TimeZone_AFRICA_MONROVIA() TimeZone
- func TimeZone_AFRICA_NAIROBI() TimeZone
- func TimeZone_AFRICA_NDJAMENA() TimeZone
- func TimeZone_AFRICA_SAO_TOME() TimeZone
- func TimeZone_AFRICA_TRIPOLI() TimeZone
- func TimeZone_AFRICA_TUNIS() TimeZone
- func TimeZone_AFRICA_WINDHOEK() TimeZone
- func TimeZone_AMERICA_ADAK() TimeZone
- func TimeZone_AMERICA_ANCHORAGE() TimeZone
- func TimeZone_AMERICA_ARAGUAINA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_BUENOS_AIRES() TimeZone
- func TimeZone_AMERICA_ARGENTINA_CATAMARCA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_CORDOBA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_JUJUY() TimeZone
- func TimeZone_AMERICA_ARGENTINA_LA_RIOJA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_MENDOZA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_RIO_GALLEGOS() TimeZone
- func TimeZone_AMERICA_ARGENTINA_SALTA() TimeZone
- func TimeZone_AMERICA_ARGENTINA_SAN_JUAN() TimeZone
- func TimeZone_AMERICA_ARGENTINA_SAN_LUIS() TimeZone
- func TimeZone_AMERICA_ARGENTINA_TUCUMAN() TimeZone
- func TimeZone_AMERICA_ARGENTINA_USHUAIA() TimeZone
- func TimeZone_AMERICA_ASUNCION() TimeZone
- func TimeZone_AMERICA_BAHIA() TimeZone
- func TimeZone_AMERICA_BAHIA_BANDERAS() TimeZone
- func TimeZone_AMERICA_BARBADOS() TimeZone
- func TimeZone_AMERICA_BELEM() TimeZone
- func TimeZone_AMERICA_BELIZE() TimeZone
- func TimeZone_AMERICA_BOA_VISTA() TimeZone
- func TimeZone_AMERICA_BOGOTA() TimeZone
- func TimeZone_AMERICA_BOISE() TimeZone
- func TimeZone_AMERICA_CAMBRIDGE_BAY() TimeZone
- func TimeZone_AMERICA_CAMPO_GRANDE() TimeZone
- func TimeZone_AMERICA_CANCUN() TimeZone
- func TimeZone_AMERICA_CARACAS() TimeZone
- func TimeZone_AMERICA_CAYENNE() TimeZone
- func TimeZone_AMERICA_CHICAGO() TimeZone
- func TimeZone_AMERICA_CHIHUAHUA() TimeZone
- func TimeZone_AMERICA_CIUDAD_JUAREZ() TimeZone
- func TimeZone_AMERICA_COSTA_RICA() TimeZone
- func TimeZone_AMERICA_CUIABA() TimeZone
- func TimeZone_AMERICA_DANMARKSHAVN() TimeZone
- func TimeZone_AMERICA_DAWSON() TimeZone
- func TimeZone_AMERICA_DAWSON_CREEK() TimeZone
- func TimeZone_AMERICA_DENVER() TimeZone
- func TimeZone_AMERICA_DETROIT() TimeZone
- func TimeZone_AMERICA_EDMONTON() TimeZone
- func TimeZone_AMERICA_EIRUNEPE() TimeZone
- func TimeZone_AMERICA_EL_SALVADOR() TimeZone
- func TimeZone_AMERICA_FORTALEZA() TimeZone
- func TimeZone_AMERICA_FORT_NELSON() TimeZone
- func TimeZone_AMERICA_GLACE_BAY() TimeZone
- func TimeZone_AMERICA_GOOSE_BAY() TimeZone
- func TimeZone_AMERICA_GRAND_TURK() TimeZone
- func TimeZone_AMERICA_GUATEMALA() TimeZone
- func TimeZone_AMERICA_GUAYAQUIL() TimeZone
- func TimeZone_AMERICA_GUYANA() TimeZone
- func TimeZone_AMERICA_HALIFAX() TimeZone
- func TimeZone_AMERICA_HAVANA() TimeZone
- func TimeZone_AMERICA_HERMOSILLO() TimeZone
- func TimeZone_AMERICA_INDIANA_INDIANAPOLIS() TimeZone
- func TimeZone_AMERICA_INDIANA_KNOX() TimeZone
- func TimeZone_AMERICA_INDIANA_MARENGO() TimeZone
- func TimeZone_AMERICA_INDIANA_PETERSBURG() TimeZone
- func TimeZone_AMERICA_INDIANA_TELL_CITY() TimeZone
- func TimeZone_AMERICA_INDIANA_VEVAY() TimeZone
- func TimeZone_AMERICA_INDIANA_VINCENNES() TimeZone
- func TimeZone_AMERICA_INDIANA_WINAMAC() TimeZone
- func TimeZone_AMERICA_INUVIK() TimeZone
- func TimeZone_AMERICA_IQALUIT() TimeZone
- func TimeZone_AMERICA_JAMAICA() TimeZone
- func TimeZone_AMERICA_JUNEAU() TimeZone
- func TimeZone_AMERICA_KENTUCKY_LOUISVILLE() TimeZone
- func TimeZone_AMERICA_KENTUCKY_MONTICELLO() TimeZone
- func TimeZone_AMERICA_LA_PAZ() TimeZone
- func TimeZone_AMERICA_LIMA() TimeZone
- func TimeZone_AMERICA_LOS_ANGELES() TimeZone
- func TimeZone_AMERICA_MACEIO() TimeZone
- func TimeZone_AMERICA_MANAGUA() TimeZone
- func TimeZone_AMERICA_MANAUS() TimeZone
- func TimeZone_AMERICA_MARTINIQUE() TimeZone
- func TimeZone_AMERICA_MATAMOROS() TimeZone
- func TimeZone_AMERICA_MAZATLAN() TimeZone
- func TimeZone_AMERICA_MENOMINEE() TimeZone
- func TimeZone_AMERICA_MERIDA() TimeZone
- func TimeZone_AMERICA_METLAKATLA() TimeZone
- func TimeZone_AMERICA_MEXICO_CITY() TimeZone
- func TimeZone_AMERICA_MIQUELON() TimeZone
- func TimeZone_AMERICA_MONCTON() TimeZone
- func TimeZone_AMERICA_MONTERREY() TimeZone
- func TimeZone_AMERICA_MONTEVIDEO() TimeZone
- func TimeZone_AMERICA_NEW_YORK() TimeZone
- func TimeZone_AMERICA_NOME() TimeZone
- func TimeZone_AMERICA_NORONHA() TimeZone
- func TimeZone_AMERICA_NORTH_DAKOTA_BEULAH() TimeZone
- func TimeZone_AMERICA_NORTH_DAKOTA_CENTER() TimeZone
- func TimeZone_AMERICA_NORTH_DAKOTA_NEW_SALEM() TimeZone
- func TimeZone_AMERICA_NUUK() TimeZone
- func TimeZone_AMERICA_OJINAGA() TimeZone
- func TimeZone_AMERICA_PANAMA() TimeZone
- func TimeZone_AMERICA_PARAMARIBO() TimeZone
- func TimeZone_AMERICA_PHOENIX() TimeZone
- func TimeZone_AMERICA_PORTO_VELHO() TimeZone
- func TimeZone_AMERICA_PORT_MINUS_AU_MINUS_PRINCE() TimeZone
- func TimeZone_AMERICA_PUERTO_RICO() TimeZone
- func TimeZone_AMERICA_PUNTA_ARENAS() TimeZone
- func TimeZone_AMERICA_RANKIN_INLET() TimeZone
- func TimeZone_AMERICA_RECIFE() TimeZone
- func TimeZone_AMERICA_REGINA() TimeZone
- func TimeZone_AMERICA_RESOLUTE() TimeZone
- func TimeZone_AMERICA_RIO_BRANCO() TimeZone
- func TimeZone_AMERICA_SANTAREM() TimeZone
- func TimeZone_AMERICA_SANTIAGO() TimeZone
- func TimeZone_AMERICA_SANTO_DOMINGO() TimeZone
- func TimeZone_AMERICA_SAO_PAULO() TimeZone
- func TimeZone_AMERICA_SCORESBYSUND() TimeZone
- func TimeZone_AMERICA_SITKA() TimeZone
- func TimeZone_AMERICA_ST_JOHNS() TimeZone
- func TimeZone_AMERICA_SWIFT_CURRENT() TimeZone
- func TimeZone_AMERICA_TEGUCIGALPA() TimeZone
- func TimeZone_AMERICA_THULE() TimeZone
- func TimeZone_AMERICA_TIJUANA() TimeZone
- func TimeZone_AMERICA_TORONTO() TimeZone
- func TimeZone_AMERICA_VANCOUVER() TimeZone
- func TimeZone_AMERICA_WHITEHORSE() TimeZone
- func TimeZone_AMERICA_WINNIPEG() TimeZone
- func TimeZone_AMERICA_YAKUTAT() TimeZone
- func TimeZone_AMERICA_YELLOWKNIFE() TimeZone
- func TimeZone_ANTARCTICA_CASEY() TimeZone
- func TimeZone_ANTARCTICA_DAVIS() TimeZone
- func TimeZone_ANTARCTICA_MACQUARIE() TimeZone
- func TimeZone_ANTARCTICA_MAWSON() TimeZone
- func TimeZone_ANTARCTICA_PALMER() TimeZone
- func TimeZone_ANTARCTICA_ROTHERA() TimeZone
- func TimeZone_ANTARCTICA_TROLL() TimeZone
- func TimeZone_ASIA_ALMATY() TimeZone
- func TimeZone_ASIA_AMMAN() TimeZone
- func TimeZone_ASIA_ANADYR() TimeZone
- func TimeZone_ASIA_AQTAU() TimeZone
- func TimeZone_ASIA_AQTOBE() TimeZone
- func TimeZone_ASIA_ASHGABAT() TimeZone
- func TimeZone_ASIA_ATYRAU() TimeZone
- func TimeZone_ASIA_BAGHDAD() TimeZone
- func TimeZone_ASIA_BAKU() TimeZone
- func TimeZone_ASIA_BANGKOK() TimeZone
- func TimeZone_ASIA_BARNAUL() TimeZone
- func TimeZone_ASIA_BEIRUT() TimeZone
- func TimeZone_ASIA_BISHKEK() TimeZone
- func TimeZone_ASIA_CHITA() TimeZone
- func TimeZone_ASIA_CHOIBALSAN() TimeZone
- func TimeZone_ASIA_COLOMBO() TimeZone
- func TimeZone_ASIA_DAMASCUS() TimeZone
- func TimeZone_ASIA_DHAKA() TimeZone
- func TimeZone_ASIA_DILI() TimeZone
- func TimeZone_ASIA_DUBAI() TimeZone
- func TimeZone_ASIA_DUSHANBE() TimeZone
- func TimeZone_ASIA_FAMAGUSTA() TimeZone
- func TimeZone_ASIA_GAZA() TimeZone
- func TimeZone_ASIA_HEBRON() TimeZone
- func TimeZone_ASIA_HONG_KONG() TimeZone
- func TimeZone_ASIA_HOVD() TimeZone
- func TimeZone_ASIA_HO_CHI_MINH() TimeZone
- func TimeZone_ASIA_IRKUTSK() TimeZone
- func TimeZone_ASIA_JAKARTA() TimeZone
- func TimeZone_ASIA_JAYAPURA() TimeZone
- func TimeZone_ASIA_JERUSALEM() TimeZone
- func TimeZone_ASIA_KABUL() TimeZone
- func TimeZone_ASIA_KAMCHATKA() TimeZone
- func TimeZone_ASIA_KARACHI() TimeZone
- func TimeZone_ASIA_KATHMANDU() TimeZone
- func TimeZone_ASIA_KHANDYGA() TimeZone
- func TimeZone_ASIA_KOLKATA() TimeZone
- func TimeZone_ASIA_KRASNOYARSK() TimeZone
- func TimeZone_ASIA_KUCHING() TimeZone
- func TimeZone_ASIA_MACAU() TimeZone
- func TimeZone_ASIA_MAGADAN() TimeZone
- func TimeZone_ASIA_MAKASSAR() TimeZone
- func TimeZone_ASIA_MANILA() TimeZone
- func TimeZone_ASIA_NICOSIA() TimeZone
- func TimeZone_ASIA_NOVOKUZNETSK() TimeZone
- func TimeZone_ASIA_NOVOSIBIRSK() TimeZone
- func TimeZone_ASIA_OMSK() TimeZone
- func TimeZone_ASIA_ORAL() TimeZone
- func TimeZone_ASIA_PONTIANAK() TimeZone
- func TimeZone_ASIA_PYONGYANG() TimeZone
- func TimeZone_ASIA_QATAR() TimeZone
- func TimeZone_ASIA_QOSTANAY() TimeZone
- func TimeZone_ASIA_QYZYLORDA() TimeZone
- func TimeZone_ASIA_RIYADH() TimeZone
- func TimeZone_ASIA_SAKHALIN() TimeZone
- func TimeZone_ASIA_SAMARKAND() TimeZone
- func TimeZone_ASIA_SEOUL() TimeZone
- func TimeZone_ASIA_SHANGHAI() TimeZone
- func TimeZone_ASIA_SINGAPORE() TimeZone
- func TimeZone_ASIA_SREDNEKOLYMSK() TimeZone
- func TimeZone_ASIA_TAIPEI() TimeZone
- func TimeZone_ASIA_TASHKENT() TimeZone
- func TimeZone_ASIA_TBILISI() TimeZone
- func TimeZone_ASIA_TEHRAN() TimeZone
- func TimeZone_ASIA_THIMPHU() TimeZone
- func TimeZone_ASIA_TOKYO() TimeZone
- func TimeZone_ASIA_TOMSK() TimeZone
- func TimeZone_ASIA_ULAANBAATAR() TimeZone
- func TimeZone_ASIA_URUMQI() TimeZone
- func TimeZone_ASIA_UST_MINUS_NERA() TimeZone
- func TimeZone_ASIA_VLADIVOSTOK() TimeZone
- func TimeZone_ASIA_YAKUTSK() TimeZone
- func TimeZone_ASIA_YANGON() TimeZone
- func TimeZone_ASIA_YEKATERINBURG() TimeZone
- func TimeZone_ASIA_YEREVAN() TimeZone
- func TimeZone_ATLANTIC_AZORES() TimeZone
- func TimeZone_ATLANTIC_BERMUDA() TimeZone
- func TimeZone_ATLANTIC_CANARY() TimeZone
- func TimeZone_ATLANTIC_CAPE_VERDE() TimeZone
- func TimeZone_ATLANTIC_FAROE() TimeZone
- func TimeZone_ATLANTIC_MADEIRA() TimeZone
- func TimeZone_ATLANTIC_SOUTH_GEORGIA() TimeZone
- func TimeZone_ATLANTIC_STANLEY() TimeZone
- func TimeZone_AUSTRALIA_ADELAIDE() TimeZone
- func TimeZone_AUSTRALIA_BRISBANE() TimeZone
- func TimeZone_AUSTRALIA_BROKEN_HILL() TimeZone
- func TimeZone_AUSTRALIA_DARWIN() TimeZone
- func TimeZone_AUSTRALIA_EUCLA() TimeZone
- func TimeZone_AUSTRALIA_HOBART() TimeZone
- func TimeZone_AUSTRALIA_LINDEMAN() TimeZone
- func TimeZone_AUSTRALIA_LORD_HOWE() TimeZone
- func TimeZone_AUSTRALIA_MELBOURNE() TimeZone
- func TimeZone_AUSTRALIA_PERTH() TimeZone
- func TimeZone_AUSTRALIA_SYDNEY() TimeZone
- func TimeZone_CET() TimeZone
- func TimeZone_CST6CDT() TimeZone
- func TimeZone_EET() TimeZone
- func TimeZone_EST() TimeZone
- func TimeZone_EST5EDT() TimeZone
- func TimeZone_ETC_GMT() TimeZone
- func TimeZone_ETC_GMT_MINUS_1() TimeZone
- func TimeZone_ETC_GMT_MINUS_2() TimeZone
- func TimeZone_ETC_GMT_MINUS_3() TimeZone
- func TimeZone_ETC_GMT_MINUS_4() TimeZone
- func TimeZone_ETC_GMT_MINUS_5() TimeZone
- func TimeZone_ETC_GMT_MINUS_6() TimeZone
- func TimeZone_ETC_GMT_MINUS_7() TimeZone
- func TimeZone_ETC_GMT_MINUS_8() TimeZone
- func TimeZone_ETC_GMT_MINUS_9() TimeZone
- func TimeZone_ETC_GMT_MINUS_10() TimeZone
- func TimeZone_ETC_GMT_MINUS_11() TimeZone
- func TimeZone_ETC_GMT_MINUS_12() TimeZone
- func TimeZone_ETC_GMT_MINUS_13() TimeZone
- func TimeZone_ETC_GMT_MINUS_14() TimeZone
- func TimeZone_ETC_GMT_PLUS_1() TimeZone
- func TimeZone_ETC_GMT_PLUS_2() TimeZone
- func TimeZone_ETC_GMT_PLUS_3() TimeZone
- func TimeZone_ETC_GMT_PLUS_4() TimeZone
- func TimeZone_ETC_GMT_PLUS_5() TimeZone
- func TimeZone_ETC_GMT_PLUS_6() TimeZone
- func TimeZone_ETC_GMT_PLUS_7() TimeZone
- func TimeZone_ETC_GMT_PLUS_8() TimeZone
- func TimeZone_ETC_GMT_PLUS_9() TimeZone
- func TimeZone_ETC_GMT_PLUS_10() TimeZone
- func TimeZone_ETC_GMT_PLUS_11() TimeZone
- func TimeZone_ETC_GMT_PLUS_12() TimeZone
- func TimeZone_ETC_UTC() TimeZone
- func TimeZone_EUROPE_ANDORRA() TimeZone
- func TimeZone_EUROPE_ASTRAKHAN() TimeZone
- func TimeZone_EUROPE_ATHENS() TimeZone
- func TimeZone_EUROPE_BELGRADE() TimeZone
- func TimeZone_EUROPE_BERLIN() TimeZone
- func TimeZone_EUROPE_BRUSSELS() TimeZone
- func TimeZone_EUROPE_BUCHAREST() TimeZone
- func TimeZone_EUROPE_BUDAPEST() TimeZone
- func TimeZone_EUROPE_CHISINAU() TimeZone
- func TimeZone_EUROPE_DUBLIN() TimeZone
- func TimeZone_EUROPE_GIBRALTAR() TimeZone
- func TimeZone_EUROPE_HELSINKI() TimeZone
- func TimeZone_EUROPE_ISTANBUL() TimeZone
- func TimeZone_EUROPE_KALININGRAD() TimeZone
- func TimeZone_EUROPE_KIROV() TimeZone
- func TimeZone_EUROPE_KYIV() TimeZone
- func TimeZone_EUROPE_LISBON() TimeZone
- func TimeZone_EUROPE_LONDON() TimeZone
- func TimeZone_EUROPE_MADRID() TimeZone
- func TimeZone_EUROPE_MALTA() TimeZone
- func TimeZone_EUROPE_MINSK() TimeZone
- func TimeZone_EUROPE_MOSCOW() TimeZone
- func TimeZone_EUROPE_PARIS() TimeZone
- func TimeZone_EUROPE_PRAGUE() TimeZone
- func TimeZone_EUROPE_RIGA() TimeZone
- func TimeZone_EUROPE_ROME() TimeZone
- func TimeZone_EUROPE_SAMARA() TimeZone
- func TimeZone_EUROPE_SARATOV() TimeZone
- func TimeZone_EUROPE_SIMFEROPOL() TimeZone
- func TimeZone_EUROPE_SOFIA() TimeZone
- func TimeZone_EUROPE_TALLINN() TimeZone
- func TimeZone_EUROPE_TIRANE() TimeZone
- func TimeZone_EUROPE_ULYANOVSK() TimeZone
- func TimeZone_EUROPE_VIENNA() TimeZone
- func TimeZone_EUROPE_VILNIUS() TimeZone
- func TimeZone_EUROPE_VOLGOGRAD() TimeZone
- func TimeZone_EUROPE_WARSAW() TimeZone
- func TimeZone_EUROPE_ZURICH() TimeZone
- func TimeZone_FACTORY() TimeZone
- func TimeZone_HST() TimeZone
- func TimeZone_INDIAN_CHAGOS() TimeZone
- func TimeZone_INDIAN_MALDIVES() TimeZone
- func TimeZone_INDIAN_MAURITIUS() TimeZone
- func TimeZone_MET() TimeZone
- func TimeZone_MST() TimeZone
- func TimeZone_MST7MDT() TimeZone
- func TimeZone_Of(timezoneName *string) TimeZone
- func TimeZone_PACIFIC_APIA() TimeZone
- func TimeZone_PACIFIC_AUCKLAND() TimeZone
- func TimeZone_PACIFIC_BOUGAINVILLE() TimeZone
- func TimeZone_PACIFIC_CHATHAM() TimeZone
- func TimeZone_PACIFIC_EASTER() TimeZone
- func TimeZone_PACIFIC_EFATE() TimeZone
- func TimeZone_PACIFIC_FAKAOFO() TimeZone
- func TimeZone_PACIFIC_FIJI() TimeZone
- func TimeZone_PACIFIC_GALAPAGOS() TimeZone
- func TimeZone_PACIFIC_GAMBIER() TimeZone
- func TimeZone_PACIFIC_GUADALCANAL() TimeZone
- func TimeZone_PACIFIC_GUAM() TimeZone
- func TimeZone_PACIFIC_HONOLULU() TimeZone
- func TimeZone_PACIFIC_KANTON() TimeZone
- func TimeZone_PACIFIC_KIRITIMATI() TimeZone
- func TimeZone_PACIFIC_KOSRAE() TimeZone
- func TimeZone_PACIFIC_KWAJALEIN() TimeZone
- func TimeZone_PACIFIC_MARQUESAS() TimeZone
- func TimeZone_PACIFIC_NAURU() TimeZone
- func TimeZone_PACIFIC_NIUE() TimeZone
- func TimeZone_PACIFIC_NORFOLK() TimeZone
- func TimeZone_PACIFIC_NOUMEA() TimeZone
- func TimeZone_PACIFIC_PAGO_PAGO() TimeZone
- func TimeZone_PACIFIC_PALAU() TimeZone
- func TimeZone_PACIFIC_PITCAIRN() TimeZone
- func TimeZone_PACIFIC_PORT_MORESBY() TimeZone
- func TimeZone_PACIFIC_RAROTONGA() TimeZone
- func TimeZone_PACIFIC_TAHITI() TimeZone
- func TimeZone_PACIFIC_TARAWA() TimeZone
- func TimeZone_PACIFIC_TONGATAPU() TimeZone
- func TimeZone_PST8PDT() TimeZone
- func TimeZone_WET() TimeZone
- type Token
- type TokenComparison
- type Tokenization
- type TokenizedStringFragments
- type TreeInspector
- type UniqueResourceNameOptions
- type ValidationResult
- type ValidationResults
This section is empty.
This section is empty.
func App_IsApp(obj interface{}) *bool
Checks if an object is an instance of the `App` class.
Returns: `true` if `obj` is an `App`.
func App_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func App_IsStage(x interface{}) *bool
Test whether the given construct is a stage.
Extract the full resource name from an ARN.
Necessary for resource names (paths) that may contain the separator, like `arn:aws:iam::111111111111:role/path/to/role/name`.
Only works if we statically know the expected `resourceType` beforehand, since we're going to use that to split the string on ':<resourceType>/' (and take the right-hand side).
We can't extract the 'resourceType' from the ARN at hand, because CloudFormation Expressions only allow literals in the 'separator' argument to `{ Fn::Split }`, and so it can't be `{ Fn::Select: [5, { Fn::Split: [':', ARN] }}`.
Only necessary for ARN formats for which the type-name separator is `/`.
func Arn_Format(components *ArnComponents, stack Stack) *string
Creates an ARN from components.
If `partition`, `region` or `account` are not specified, the stack's partition, region and account will be used.
If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.
The ARN will be formatted as follows:
arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}
The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.
func AspectPriority_DEFAULT() *float64
func AspectPriority_MUTATING() *float64
func AspectPriority_READONLY() *float64
func AssetStaging_BUNDLING_INPUT_DIR() *string
func AssetStaging_BUNDLING_OUTPUT_DIR() *string
func AssetStaging_ClearAssetHashCache()
Clears the asset hash cache.
func AssetStaging_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func Aws_NOTIFICATION_ARNS() *[]*string
func BootstraplessSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string
func BootstraplessSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string
func BootstraplessSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string
func BootstraplessSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string
func BootstraplessSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string
func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string
func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string
func BootstraplessSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string
func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string
func BootstraplessSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string
func BootstraplessSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string
func BootstraplessSynthesizer_DEFAULT_QUALIFIER() *string
func CfnCodeDeployBlueGreenHook_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnCodeDeployBlueGreenHook_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCondition_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnCondition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCustomResource_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomResource_IsCfnCustomResource(x interface{}) *bool
Checks whether the given object is a CfnCustomResource.
func CfnCustomResource_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnCustomResource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCustomResource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnElement_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnElement_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGuardHook_CFN_RESOURCE_TYPE_NAME() *string
func CfnGuardHook_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnGuardHook_IsCfnGuardHook(x interface{}) *bool
Checks whether the given object is a CfnGuardHook.
func CfnGuardHook_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGuardHook_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookDefaultVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnHookDefaultVersion_IsCfnHookDefaultVersion(x interface{}) *bool
Checks whether the given object is a CfnHookDefaultVersion.
func CfnHookDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookDefaultVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookTypeConfig_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnHookTypeConfig_IsCfnHookTypeConfig(x interface{}) *bool
Checks whether the given object is a CfnHookTypeConfig.
func CfnHookTypeConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookTypeConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnHookVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnHookVersion_IsCfnHookVersion(x interface{}) *bool
Checks whether the given object is a CfnHookVersion.
func CfnHookVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnHook_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnHook_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnJson_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnLambdaHook_CFN_RESOURCE_TYPE_NAME() *string
func CfnLambdaHook_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnLambdaHook_IsCfnLambdaHook(x interface{}) *bool
Checks whether the given object is a CfnLambdaHook.
func CfnLambdaHook_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLambdaHook_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMacro_CFN_RESOURCE_TYPE_NAME() *string
func CfnMacro_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnMacro_IsCfnMacro(x interface{}) *bool
Checks whether the given object is a CfnMacro.
func CfnMacro_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMacro_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMapping_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnMapping_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnModuleDefaultVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnModuleDefaultVersion_IsCfnModuleDefaultVersion(x interface{}) *bool
Checks whether the given object is a CfnModuleDefaultVersion.
func CfnModuleDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModuleDefaultVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnModuleVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnModuleVersion_IsCfnModuleVersion(x interface{}) *bool
Checks whether the given object is a CfnModuleVersion.
func CfnModuleVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModuleVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnOutput_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnOutput_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnParameter_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnParameter_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnPublicTypeVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnPublicTypeVersion_IsCfnPublicTypeVersion(x interface{}) *bool
Checks whether the given object is a CfnPublicTypeVersion.
func CfnPublicTypeVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPublicTypeVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPublisher_CFN_RESOURCE_TYPE_NAME() *string
func CfnPublisher_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnPublisher_IsCfnPublisher(x interface{}) *bool
Checks whether the given object is a CfnPublisher.
func CfnPublisher_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPublisher_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRefElement_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnRefElement_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceDefaultVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnResourceDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResourceDefaultVersion_IsCfnResourceDefaultVersion(x interface{}) *bool
Checks whether the given object is a CfnResourceDefaultVersion.
func CfnResourceDefaultVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceVersion_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnResourceVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResourceVersion_IsCfnResourceVersion(x interface{}) *bool
Checks whether the given object is a CfnResourceVersion.
func CfnResourceVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnResource_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnResource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRule_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStackSet_CFN_RESOURCE_TYPE_NAME() *string
func CfnStackSet_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnStackSet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStackSet_IsCfnStackSet(x interface{}) *bool
Checks whether the given object is a CfnStackSet.
func CfnStackSet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
func CfnStack_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnStack_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStack_IsCfnStack(x interface{}) *bool
Checks whether the given object is a CfnStack.
func CfnStack_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTypeActivation_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnTypeActivation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTypeActivation_IsCfnTypeActivation(x interface{}) *bool
Checks whether the given object is a CfnTypeActivation.
func CfnTypeActivation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWaitConditionHandle_IsCfnElement ¶
func CfnWaitConditionHandle_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnWaitConditionHandle_IsConstruct ¶
func CfnWaitConditionHandle_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME() *string
func CfnWaitCondition_IsCfnElement(x interface{}) *bool
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: The construct as a stack element or undefined if it is not a stack element.
func CfnWaitCondition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWaitCondition_IsCfnWaitCondition(x interface{}) *bool
Checks whether the given object is a CfnWaitCondition.
func CfnWaitCondition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CustomResourceProviderBase_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
Returns a stack-level singleton ARN (service token) for the custom resource provider.
Returns: the service token of the custom resource provider, which should be used when defining a `CustomResource`.
func CustomResourceProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CustomResource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
Returns true if the construct was created by CDK, and false otherwise.
Check whether the given construct is a Resource.
func CustomResource_PROPERTY_INJECTION_ID() *string
func DefaultStackSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string
func DefaultStackSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string
func DefaultStackSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string
func DefaultStackSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string
func DefaultStackSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string
func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string
func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string
func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string
func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string
func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string
func DefaultStackSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string
func DefaultStackSynthesizer_DEFAULT_QUALIFIER() *string
A Docker build secret from a file source.
Returns: The latter half required for `--secret`.
func Errors_IsAssertionError(x interface{}) *bool
Test whether the given error is a AssertionError.
An AssertionError is thrown when an assertion fails.
func Errors_IsAssumptionError(x interface{}) *bool
Test whether the given error is an AssumptionError.
An AssumptionError is thrown when a construct made an assumption somewhere that doesn't hold true. This error always indicates a bug in the construct.
func Errors_IsCloudAssemblyError(x interface{}) *bool
Test whether the given error is a CloudAssemblyError.
A CloudAssemblyError is thrown for unexpected problems with the synthesized assembly.
func Errors_IsConstructError(x interface{}) *bool
Test whether the given errors is a ConstructionError.
A ConstructionError is a generic error that will be thrown during the App construction or synthesis. To check for more specific errors, use the respective methods.
func Errors_IsExecutionError(x interface{}) *bool
Test whether the given error is an ExecutionError.
An ExecutionError is thrown if an externally executed script or code failed.
func Errors_IsValidationError(x interface{}) *bool
Test whether the given error is a ValidationError.
A ValidationError is thrown when input props are failing to pass the rules of the construct. It usually means the underlying CloudFormation resource(s) would not deploy with a given configuration.
Copies an entire directory structure.
func FileSystem_Fingerprint(fileOrDirectory *string, options *FingerprintOptions) *string
Produces fingerprint based on the contents of a single file or an entire directory tree.
Line endings are converted from CRLF to LF.
The fingerprint will also include: 1. An extra string if defined in `options.extra`. 2. The symlink follow mode value.
Checks whether a directory is empty.
Creates a unique temporary directory in the **system temp directory**.
func FileSystem_Rmrf(dirname *string)
Deletes a directory.
func FileSystem_Tmpdir() *string
The intrinsic function “Fn::Base64“ returns the Base64 representation of the input string.
This function is typically used to pass encoded data to Amazon EC2 instances by way of the UserData property.
Returns: a token represented as a string.
The intrinsic function “Fn::Cidr“ returns the specified Cidr address block.
Returns: a token represented as a string.
The intrinsic function “Fn::FindInMap“ returns the value corresponding to keys in a two-level map that is declared in the Mappings section.
Warning: do not use with lazy mappings as this function will not guarentee a lazy mapping to render in the template. Prefer to use `CfnMapping.findInMap` in general.
Returns: a token represented as a string.
The intrinsic function “Fn::GetAZs“ returns an array that lists Availability Zones for a specified region.
Because customers have access to different Availability Zones, the intrinsic function “Fn::GetAZs“ enables template authors to write templates that adapt to the calling user's access. That way you don't have to hard-code a full list of Availability Zones for a specified region.
Returns: a token represented as a string array.
Like `Fn.importValue`, but import a list with a known length.
If you explicitly want a list with an unknown length, call `Fn.split(',', Fn.importValue(exportName))`. See the documentation of `Fn.split` to read more about the limitations of using lists of unknown length.
`Fn.importListValue(exportName, assumedLength)` is the same as `Fn.split(',', Fn.importValue(exportName), assumedLength)`, but easier to read and impossible to forget to pass `assumedLength`.
The intrinsic function “Fn::ImportValue“ returns the value of an output exported by another stack.
You typically use this function to create cross-stack references. In the following example template snippets, Stack A exports VPC security group values and Stack B imports them.
Returns: a token represented as a string.
The intrinsic function “Fn::Join“ appends a set of values into a single value, separated by the specified delimiter.
If a delimiter is the empty string, the set of values are concatenated with no delimiter.
Returns: a token represented as a string.
func Fn_Len(array interface{}) *float64
The intrinsic function `Fn::Length` returns the number of elements within an array or an intrinsic function that returns an array.
The “Ref“ intrinsic function returns the value of the specified parameter or resource.
Note that it doesn't validate the logicalName, it mainly serves parameter/resource reference defined in a “CfnInclude“ template.
Returns all values for a specified parameter type.
Returns: a token represented as a string array.
The intrinsic function “Fn::Select“ returns a single object from a list of objects by index.
Returns: a token represented as a string.
Split a string token into a token list of string values.
Specify the location of splits with a delimiter such as ',' (a comma). Renders to the `Fn::Split` intrinsic function.
Lists with unknown lengths (default) -------------------------------------
Since this function is used to work with deploy-time values, if `assumedLength` is not given the CDK cannot know the length of the resulting list at synthesis time. This brings the following restrictions:
- You must use `Fn.select(i, list)` to pick elements out of the list (you must not use `list[i]`).
- You cannot add elements to the list, remove elements from the list, combine two such lists together, or take a slice of the list.
- You cannot pass the list to constructs that do any of the above.
The only valid operation with such a tokenized list is to pass it unmodified to a CloudFormation Resource construct.
Lists with assumed lengths --------------------------
Pass `assumedLength` if you know the length of the list that will be produced by splitting. The actual list length at deploy time may be *longer* than the number you pass, but not *shorter*.
The returned list will look like:
``` [Fn.select(0, split), Fn.select(1, split), Fn.select(2, split), ...] ```
The restrictions from the section "Lists with unknown lengths" will now be lifted, at the expense of having to know and fix the length of the list.
Returns: a token represented as a string array.
The intrinsic function “Fn::Sub“ substitutes variables in an input string with values that you specify.
In your templates, you can use this function to construct commands or outputs that include values that aren't available until you create or update a stack.
Returns: a token represented as a string.
func Fn_ToJsonString(object interface{}) *string
The `Fn::ToJsonString` intrinsic function converts an object or array to its corresponding JSON string.
Returns an attribute value or list of values for a specific parameter and attribute.
Returns: a token represented as a string.
Returns a list of all attribute values for a given parameter type and attribute.
Returns: a token represented as a string array.
Defer the one-time calculation of a list value to synthesis time.
Use this if you want to render a list to a template whose actual value depends on some state mutation that may happen after the construct has been created.
If you are simply looking to force a value to a `string[]` type and don't need the calculation to be deferred, use `Token.asList()` instead.
The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in.
Defer the one-time calculation of a number value to synthesis time.
Use this if you want to render a number to a template whose actual value depends on some state mutation that may happen after the construct has been created.
If you are simply looking to force a value to a `number` type and don't need the calculation to be deferred, use `Token.asNumber()` instead.
The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in.
Defer the one-time calculation of a string value to synthesis time.
Use this if you want to render a string to a template whose actual value depends on some state mutation that may happen after the construct has been created.
If you are simply looking to force a value to a `string` type and don't need the calculation to be deferred, use `Token.asString()` instead.
The inner function will only be invoked once, and the resolved value cannot depend on the Stack the Token is used in.
func Lazy_UncachedList(producer IListProducer, options *LazyListValueOptions) *[]*string
Defer the calculation of a list value to synthesis time.
Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.list()` instead.
The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors.
func Lazy_UncachedNumber(producer INumberProducer) *float64
Defer the calculation of a number value to synthesis time.
Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.number()` instead.
The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors.
func Lazy_UncachedString(producer IStringProducer, options *LazyStringValueOptions) *string
Defer the calculation of a string value to synthesis time.
Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.string()` instead.
The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors.
Returns a CloudFormation-compatible unique identifier for a construct based on its path.
The identifier includes a human readable portion rendered from the path components and a hash suffix.
TODO (v2): replace with API to use `constructs.Node`.
Returns: a unique id based on the construct path.
Return the construct path of the given construct, starting at the nearest enclosing Stack.
Skips over Nested Stacks, in other words Nested Stacks are included in the construct paths.
Returns a CloudFormation-compatible unique identifier for a construct based on its path.
The identifier includes a human readable portion rendered from the path components and a hash suffix. uniqueId is not unique if multiple copies of the stack are deployed. Prefer using uniqueResourceName().
Returns: a unique id based on the construct path.
Returns a CloudFormation-compatible unique identifier for a construct based on its path.
This function finds the stackName of the parent stack (non-nested) to the construct, and the ids of the components in the construct path.
The user can define allowed special characters, a separator between the elements, and the maximum length of the resource name. The name includes a human readable portion rendered from the path components, with or without user defined separators, and a hash suffix. If the resource name is longer than the maximum length, it is trimmed in the middle.
Returns: a unique resource name based on the construct path.
func NestedStack_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NestedStack_IsNestedStack(x interface{}) *bool
Checks if `x` is an object of type `NestedStack`.
func NestedStack_IsStack(x interface{}) *bool
Return whether the given object is a Stack.
We do attribute detection since we can't reliably use 'instanceof'.
Initializes AspectApplication object.
func NewAspectPriority_Override(a AspectPriority)
func NewAssetManifestBuilder_Override(a AssetManifestBuilder)
func NewBootstraplessSynthesizer_Override(b BootstraplessSynthesizer, props *BootstraplessSynthesizerProps)
Creates a new CodeDeploy blue-green ECS Hook.
Build a new condition.
The condition must be constructed with a condition token, that the condition is based on.
Create a new `AWS::CloudFormation::CustomResource`.
func NewCfnDynamicReference_Override(c CfnDynamicReference, service CfnDynamicReferenceService, key *string)
Creates an entity and binds it to a tree.
Note that the root of the tree must be a Stack object (not just any Root).
Create a new `AWS::CloudFormation::GuardHook`.
Create a new `AWS::CloudFormation::HookDefaultVersion`.
Create a new `AWS::CloudFormation::HookTypeConfig`.
Create a new `AWS::CloudFormation::HookVersion`.
Creates a new Hook object.
Create a new `AWS::CloudFormation::LambdaHook`.
Create a new `AWS::CloudFormation::Macro`.
Create a new `AWS::CloudFormation::ModuleDefaultVersion`.
Create a new `AWS::CloudFormation::ModuleVersion`.
Creates a CfnOutput value for this stack.
Creates a parameter construct.
Note that the name (logical ID) of the parameter will derive from it's `coname` and location within the stack. Therefore, it is recommended that parameters are defined at the stack level.
Create a new `AWS::CloudFormation::PublicTypeVersion`.
Create a new `AWS::CloudFormation::Publisher`.
Creates an entity and binds it to a tree.
Note that the root of the tree must be a Stack object (not just any Root).
Create a new `AWS::CloudFormation::ResourceDefaultVersion`.
Create a new `AWS::CloudFormation::ResourceVersion`.
Creates a resource construct.
Create a new `AWS::CloudFormation::StackSet`.
Create a new `AWS::CloudFormation::Stack`.
Create a new `AWS::CloudFormation::TypeActivation`.
Create a new `AWS::CloudFormation::WaitCondition`.
func NewCliCredentialsStackSynthesizer_Override(c CliCredentialsStackSynthesizer, props *CliCredentialsStackSynthesizerProps)
func NewDefaultStackSynthesizer_Override(d DefaultStackSynthesizer, props *DefaultStackSynthesizerProps)
func NewDefaultTokenResolver_Override(d DefaultTokenResolver, concat IFragmentConcatenator)
func NewDockerBuildSecret_Override(d DockerBuildSecret)
func NewDockerIgnoreStrategy_Override(d DockerIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
func NewDockerImage_Override(d DockerImage, image *string, _imageHash *string)
func NewErrors_Override(e Errors)
func NewFileSystem_Override(f FileSystem)
func NewGitIgnoreStrategy_Override(g GitIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
func NewGlobIgnoreStrategy_Override(g GlobIgnoreStrategy, absoluteRootPath *string, patterns *[]*string)
func NewIgnoreStrategy_Override(i IgnoreStrategy)
func NewIntrinsic_Override(i Intrinsic, value interface{}, options *IntrinsicProps)
func NewLegacyStackSynthesizer_Override(l LegacyStackSynthesizer)
func NewNestedStackSynthesizer_Override(n NestedStackSynthesizer, parentDeployment IStackSynthesizer)
func NewSecretValue_Override(s SecretValue, protectedValue interface{}, options *IntrinsicProps)
Construct a SecretValue (do not use!).
Do not use the constructor directly: use one of the factory functions on the class instead.
func NewStackSynthesizer_Override(s StackSynthesizer)
func NewStringConcat_Override(s StringConcat)
func NewTagManager_Override(t TagManager, tagType TagType, resourceTypeName *string, initialTags interface{}, options *TagManagerOptions)
func NewTokenizedStringFragments_Override(t TokenizedStringFragments)
func NewTreeInspector_Override(t TreeInspector)
func NewValidationResult_Override(v ValidationResult, errorMessage *string, results ValidationResults)
func NewValidationResults_Override(v ValidationResults, results *[]ValidationResult)
func PhysicalName_GENERATE_IF_NEEDED() *string
func PropertyInjectors_HasPropertyInjectors(x interface{}) *bool
Return whether the given object has a PropertyInjectors property.
We do attribute detection since we can't reliably use 'instanceof'.
func Reference_IsReference(x interface{}) *bool
Check whether this is actually a Reference.
func Resource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
Returns true if the construct was created by CDK, and false otherwise.
Check whether the given construct is a Resource.
func SecretValue_IsSecretValue(x interface{}) *bool
Test whether an object is a SecretValue.
func Stack_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func Stack_IsStack(x interface{}) *bool
Return whether the given object is a Stack.
We do attribute detection since we can't reliably use 'instanceof'.
func Stage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func Stage_IsStage(x interface{}) *bool
Test whether the given construct is a stage.
func TagManager_IsTaggable(construct interface{}) *bool
Check whether the given construct is Taggable.
func TagManager_IsTaggableV2(construct interface{}) *bool
Check whether the given construct is ITaggableV2.
func Token_AsList(value interface{}, options *EncodingOptions) *[]*string
Return a reversible list representation of this token.
func Token_AsNumber(value interface{}) *float64
Return a reversible number representation of this token.
func Token_AsString(value interface{}, options *EncodingOptions) *string
Return a reversible string representation of this token.
If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling `resolve()` on the string.
func Token_IsResolved(obj interface{}) *bool
The negation of `Token.isUnresolved()`. In TypeScript, narrows the type to exclude `IResolvable`.
func Token_IsUnresolved(obj interface{}) *bool
Returns true if obj represents an unresolved value.
One of these must be true:
- `obj` is an IResolvable - `obj` is a string containing at least one encoded `IResolvable` - `obj` is either an encoded number or list
This does NOT recurse into lists or objects to see if they contain resolvables.
func Tokenization_IsResolvable(obj interface{}) *bool
Return whether the given object is an IResolvable object.
This is different from Token.isUnresolved() which will also check for encoded Tokens, whereas this method will only do a type check on the given object.
func Tokenization_Resolve(obj interface{}, options *ResolveOptions) interface{}
Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.
Values can only be primitives, arrays or tokens. Other objects (i.e. with methods) will be rejected.
Stringify a number directly or lazily if it's a Token.
If it is an object (i.e., { Ref: 'SomeLogicalId' }), return it as-is.
type AWSEventMetadataProps struct {
Region *[]*string `field:"optional" json:"region" yaml:"region"`
Resources *[]*string `field:"optional" json:"resources" yaml:"resources"`
Version *[]*string `field:"optional" json:"version" yaml:"version"`
}
Properties for AWS EventBridge event metadata.
Example:
import "github.com/aws/aws-cdk-go/awscdkmixinspreview"
import events "github.com/aws/aws-cdk-go/awscdk"
var bucket Bucket
bucketEvents := awscdkmixinspreview.BucketEvents_FromBucket(bucket)
pattern := bucketEvents.ObjectCreatedPattern(&ObjectCreatedProps{
EventMetadata: &AWSEventMetadataProps{
Region: events.Match_Prefix(jsii.String("us-")),
Version: []*string{
jsii.String("0"),
},
},
})
type AddDockerImageAssetOptions struct {
DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
}
Options for the addDockerImageAsset operation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
addDockerImageAssetOptions := &AddDockerImageAssetOptions{
DisplayName: jsii.String("displayName"),
}
type AddFileAssetOptions struct {
DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
}
Options for the addFileAsset operation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
addFileAssetOptions := &AddFileAssetOptions{
DisplayName: jsii.String("displayName"),
}
Includes API for attaching annotations such as warning messages to constructs.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/constructs-go/constructs"
type myAspect struct {
}
func (this *myAspect) visit(node IConstruct) {
if *node instanceof cdk.CfnResource && *node.CfnResourceType == "Foo::Bar" {
this.error(*node, jsii.String("we do not want a Foo::Bar resource"))
}
}
func (this *myAspect) error(node IConstruct, message *string) {
cdk.Annotations_Of(*node).AddError(*message)
}
type myStack struct {
Stack
}
func newMyStack(scope Construct, id *string) *myStack {
this := &myStack{}
cdk.NewStack_Override(this, scope, id)
stack := cdk.NewStack()
cdk.NewCfnResource(stack, jsii.String("Foo"), &CfnResourceProps{
Type: jsii.String("Foo::Bar"),
Properties: map[string]interface{}{
"Fred": jsii.String("Thud"),
},
})
cdk.Aspects_Of(stack).Add(NewMyAspect())
return this
}
Returns the annotations API for a construct scope.
A construct which represents an entire CDK app. This construct is normally the root of the construct tree.
You would normally define an `App` instance in your program's entrypoint, then define constructs where the app is used as the parent scope.
After all the child constructs are defined within the app, you should call `app.synth()` which will emit a "cloud assembly" from this app into the directory specified by `outdir`. Cloud assemblies includes artifacts such as CloudFormation templates and assets that are needed to deploy this app into the AWS cloud.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
var bucket IBucket
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
dynamodb.NewTable(stack, jsii.String("Table"), &TableProps{
PartitionKey: &Attribute{
Name: jsii.String("id"),
Type: dynamodb.AttributeType_STRING,
},
ImportSource: &ImportSourceSpecification{
CompressionType: dynamodb.InputCompressionType_GZIP,
InputFormat: dynamodb.InputFormat_Csv(&CsvOptions{
Delimiter: jsii.String(","),
HeaderList: []*string{
jsii.String("id"),
jsii.String("name"),
},
}),
Bucket: *Bucket,
KeyPrefix: jsii.String("prefix"),
},
})
type AppProps struct {
AnalyticsReporting *bool `field:"optional" json:"analyticsReporting" yaml:"analyticsReporting"`
AutoSynth *bool `field:"optional" json:"autoSynth" yaml:"autoSynth"`
Context *map[string]interface{} `field:"optional" json:"context" yaml:"context"`
DefaultStackSynthesizer IReusableStackSynthesizer `field:"optional" json:"defaultStackSynthesizer" yaml:"defaultStackSynthesizer"`
Outdir *string `field:"optional" json:"outdir" yaml:"outdir"`
PolicyValidationBeta1 *[]IPolicyValidationPluginBeta1 `field:"optional" json:"policyValidationBeta1" yaml:"policyValidationBeta1"`
PostCliContext *map[string]interface{} `field:"optional" json:"postCliContext" yaml:"postCliContext"`
PropertyInjectors *[]IPropertyInjector `field:"optional" json:"propertyInjectors" yaml:"propertyInjectors"`
StackTraces *bool `field:"optional" json:"stackTraces" yaml:"stackTraces"`
TreeMetadata *bool `field:"optional" json:"treeMetadata" yaml:"treeMetadata"`
}
Initialization props for apps.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
app := awscdk.NewApp(&AppProps{
DefaultStackSynthesizer: appstagingsynthesizeralpha.AppStagingSynthesizer_DefaultResources(&DefaultResourcesOptions{
AppId: jsii.String("my-app-id"),
StagingBucketEncryption: awscdk.BucketEncryption_S3_MANAGED,
DeploymentIdentities: appstagingsynthesizeralpha.DeploymentIdentities_SpecifyRoles(&BootstrapRoles{
CloudFormationExecutionRole: appstagingsynthesizeralpha.BootstrapRole_FromRoleArn(jsii.String("arn:aws:iam::123456789012:role/Execute")),
DeploymentRole: appstagingsynthesizeralpha.BootstrapRole_*FromRoleArn(jsii.String("arn:aws:iam::123456789012:role/Deploy")),
LookupRole: appstagingsynthesizeralpha.BootstrapRole_*FromRoleArn(jsii.String("arn:aws:iam::123456789012:role/Lookup")),
}),
}),
})
type ArnComponents struct {
Resource *string `field:"required" json:"resource" yaml:"resource"`
Service *string `field:"required" json:"service" yaml:"service"`
Account *string `field:"optional" json:"account" yaml:"account"`
ArnFormat ArnFormat `field:"optional" json:"arnFormat" yaml:"arnFormat"`
Partition *string `field:"optional" json:"partition" yaml:"partition"`
Region *string `field:"optional" json:"region" yaml:"region"`
ResourceName *string `field:"optional" json:"resourceName" yaml:"resourceName"`
}
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
// This function handles your connect route
var connectHandler Function
webSocketApi := apigwv2.NewWebSocketApi(this, jsii.String("WebSocketApi"))
webSocketApi.AddRoute(jsii.String("$connect"), &WebSocketRouteOptions{
Integration: awscdk.NewWebSocketLambdaIntegration(jsii.String("Integration"), connectHandler),
Authorizer: awscdk.NewWebSocketIamAuthorizer(),
})
// Create an IAM user (identity)
user := iam.NewUser(this, jsii.String("User"))
webSocketArn := awscdk.stack_Of(this).FormatArn(&ArnComponents{
Service: jsii.String("execute-api"),
Resource: webSocketApi.ApiId,
})
// Grant access to the IAM user
user.AttachInlinePolicy(iam.NewPolicy(this, jsii.String("AllowInvoke"), &PolicyProps{
Statements: []PolicyStatement{
iam.NewPolicyStatement(&PolicyStatementProps{
Actions: []*string{
jsii.String("execute-api:Invoke"),
},
Effect: iam.Effect_ALLOW,
Resources: []*string{
webSocketArn,
},
}),
},
}))
func Arn_Split(arn *string, arnFormat ArnFormat) *ArnComponents
Splits the provided ARN into its components.
Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).
An enum representing the various ARN formats that different services use.
Example:
var stack Stack
// Builds "arn:<PARTITION>:lambda:<REGION>:<ACCOUNT>:function:MyFunction"
stack.FormatArn(&ArnComponents{
Service: jsii.String("lambda"),
Resource: jsii.String("function"),
ArnFormat: awscdk.ArnFormat_COLON_RESOURCE_NAME,
ResourceName: jsii.String("MyFunction"),
})
Object respresenting an Aspect application.
Stores the Aspect, the pointer to the construct it was applied to, and the priority value of that Aspect.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" import constructs "github.com/aws/constructs-go/constructs" var aspect IAspect var construct Construct aspectApplication := cdk.NewAspectApplication(construct, aspect, jsii.Number(123))
Initializes AspectApplication object.
type AspectOptions struct {
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
}
Options when Applying an Aspect.
Example:
type mutatingAspect struct {
}
func (this *mutatingAspect) visit(node IConstruct) {}
type validationAspect struct {
}
func (this *validationAspect) visit(node IConstruct) {}
stack := awscdk.Newstack()
awscdk.Aspects_Of(stack).Add(NewMutatingAspect(), &AspectOptions{
Priority: awscdk.AspectPriority_MUTATING(),
}) // Run first (mutating aspects)
awscdk.Aspects_Of(stack).Add(NewValidationAspect(), &AspectOptions{
Priority: awscdk.AspectPriority_READONLY(),
})
type AspectPriority interface {
}
Default Priority values for Aspects.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" aspectPriority := cdk.NewAspectPriority()
func NewAspectPriority() AspectPriority
type Aspects interface {
All() *[]IAspect
Applied() *[]AspectApplication
Add(aspect IAspect, options *AspectOptions)
}
Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/constructs-go/constructs"
type myAspect struct {
}
func (this *myAspect) visit(node IConstruct) {
if *node instanceof cdk.CfnResource && *node.CfnResourceType == "Foo::Bar" {
this.error(*node, jsii.String("we do not want a Foo::Bar resource"))
}
}
func (this *myAspect) error(node IConstruct, message *string) {
cdk.Annotations_Of(*node).AddError(*message)
}
type myStack struct {
Stack
}
func newMyStack(scope Construct, id *string) *myStack {
this := &myStack{}
cdk.NewStack_Override(this, scope, id)
stack := cdk.NewStack()
cdk.NewCfnResource(stack, jsii.String("Foo"), &CfnResourceProps{
Type: jsii.String("Foo::Bar"),
Properties: map[string]interface{}{
"Fred": jsii.String("Thud"),
},
})
cdk.Aspects_Of(stack).Add(NewMyAspect())
return this
}
Returns the `Aspects` object associated with a construct scope.
The type of asset hash.
NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc.
const ( AssetHashType_SOURCE AssetHashType = "SOURCE" AssetHashType_OUTPUT AssetHashType = "OUTPUT" AssetHashType_CUSTOM AssetHashType = "CUSTOM" )
type AssetManifestBuilder interface {
HasAssets() *bool
AddDockerImageAsset(stack Stack, sourceHash *string, source *cloudassemblyschema.DockerImageSource, dest *cloudassemblyschema.DockerImageDestination, options *AddDockerImageAssetOptions) *cloudassemblyschema.DockerImageDestination
AddFileAsset(stack Stack, sourceHash *string, source *cloudassemblyschema.FileSource, dest *cloudassemblyschema.FileDestination, options *AddFileAssetOptions) *cloudassemblyschema.FileDestination
DefaultAddDockerImageAsset(stack Stack, asset *DockerImageAssetSource, target *AssetManifestDockerImageDestination, options *AddDockerImageAssetOptions) *cloudassemblyschema.DockerImageDestination
DefaultAddFileAsset(stack Stack, asset *FileAssetSource, target *AssetManifestFileDestination, options *AddFileAssetOptions) *cloudassemblyschema.FileDestination
EmitManifest(stack Stack, session ISynthesisSession, options *cloudassemblyschema.AssetManifestOptions, dependencies *[]*string) *string
}
Build an asset manifest from assets added to a stack.
This class does not need to be used by app builders; it is only necessary for building Stack Synthesizers.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" assetManifestBuilder := cdk.NewAssetManifestBuilder()
func NewAssetManifestBuilder() AssetManifestBuilder
type AssetManifestDockerImageDestination struct {
RepositoryName *string `field:"required" json:"repositoryName" yaml:"repositoryName"`
DockerTagPrefix *string `field:"optional" json:"dockerTagPrefix" yaml:"dockerTagPrefix"`
Role *RoleOptions `field:"optional" json:"role" yaml:"role"`
}
The destination for a docker image asset, when it is given to the AssetManifestBuilder.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
assetManifestDockerImageDestination := &AssetManifestDockerImageDestination{
RepositoryName: jsii.String("repositoryName"),
// the properties below are optional
DockerTagPrefix: jsii.String("dockerTagPrefix"),
Role: &RoleOptions{
AssumeRoleArn: jsii.String("assumeRoleArn"),
// the properties below are optional
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
},
}
type AssetManifestFileDestination struct {
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
BucketPrefix *string `field:"optional" json:"bucketPrefix" yaml:"bucketPrefix"`
Role *RoleOptions `field:"optional" json:"role" yaml:"role"`
}
The destination for a file asset, when it is given to the AssetManifestBuilder.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
assetManifestFileDestination := &AssetManifestFileDestination{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
Role: &RoleOptions{
AssumeRoleArn: jsii.String("assumeRoleArn"),
// the properties below are optional
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
},
}
type AssetOptions struct {
AssetHash *string `field:"optional" json:"assetHash" yaml:"assetHash"`
AssetHashType AssetHashType `field:"optional" json:"assetHashType" yaml:"assetHashType"`
Bundling *BundlingOptions `field:"optional" json:"bundling" yaml:"bundling"`
}
Asset hash options.
Example:
// 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"
var dockerImage DockerImage
var localBundling ILocalBundling
assetOptions := &AssetOptions{
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []DockerVolume{
&DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
}
Stages a file or directory from a location on the file system into a staging directory.
This is controlled by the context key 'aws:cdk:asset-staging' and enabled by the CLI by default in order to ensure that when the CDK app exists, all assets are available for deployment. Otherwise, if an app references assets in temporary locations, those will not be available when it exists (see https://github.com/aws/aws-cdk/issues/1716).
The `stagedPath` property is a stringified token that represents the location of the file or directory after staging. It will be resolved only during the "prepare" stage and may be either the original path or the staged path depending on the context setting.
The file/directory are staged based on their content hash (fingerprint). This means that only if content was changed, copy will happen.
Example:
// 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"
var dockerImage DockerImage
var localBundling ILocalBundling
assetStaging := cdk.NewAssetStaging(this, jsii.String("MyAssetStaging"), &AssetStagingProps{
SourcePath: jsii.String("sourcePath"),
// the properties below are optional
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []DockerVolume{
&DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
Exclude: []*string{
jsii.String("exclude"),
},
ExtraHash: jsii.String("extraHash"),
Follow: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
})
type AssetStagingProps struct {
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
Follow SymlinkFollowMode `field:"optional" json:"follow" yaml:"follow"`
IgnoreMode IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
ExtraHash *string `field:"optional" json:"extraHash" yaml:"extraHash"`
AssetHash *string `field:"optional" json:"assetHash" yaml:"assetHash"`
AssetHashType AssetHashType `field:"optional" json:"assetHashType" yaml:"assetHashType"`
Bundling *BundlingOptions `field:"optional" json:"bundling" yaml:"bundling"`
SourcePath *string `field:"required" json:"sourcePath" yaml:"sourcePath"`
}
Initialization properties for `AssetStaging`.
Example:
// 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"
var dockerImage DockerImage
var localBundling ILocalBundling
assetStagingProps := &AssetStagingProps{
SourcePath: jsii.String("sourcePath"),
// the properties below are optional
AssetHash: jsii.String("assetHash"),
AssetHashType: cdk.AssetHashType_SOURCE,
Bundling: &BundlingOptions{
Image: dockerImage,
// the properties below are optional
BundlingFileAccess: cdk.BundlingFileAccess_VOLUME_COPY,
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Local: localBundling,
Network: jsii.String("network"),
OutputType: cdk.BundlingOutput_ARCHIVED,
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []DockerVolume{
&DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
Exclude: []*string{
jsii.String("exclude"),
},
ExtraHash: jsii.String("extraHash"),
Follow: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}
Accessor for pseudo parameters.
Since pseudo parameters need to be anchored to a stack somewhere in the construct tree, this class takes an scope parameter; the pseudo parameter values can be obtained as properties from an scoped object.
Synthesizer that reuses bootstrap roles from a different region.
A special synthesizer that behaves similarly to `DefaultStackSynthesizer`, but doesn't require bootstrapping the environment it operates in. Instead, it will re-use the Roles that were created for a different region (which is possible because IAM is a global service).
However, it will not assume asset buckets or repositories have been created, and therefore does not support assets.
The name is poorly chosen -- it does still require bootstrapping, it just does not support assets.
Used by the CodePipeline construct for the support stacks needed for cross-region replication S3 buckets. App builders do not need to use this synthesizer directly.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
bootstraplessSynthesizer := cdk.NewBootstraplessSynthesizer(&BootstraplessSynthesizerProps{
CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
DeployRoleArn: jsii.String("deployRoleArn"),
Qualifier: jsii.String("qualifier"),
})
func NewBootstraplessSynthesizer(props *BootstraplessSynthesizerProps) BootstraplessSynthesizer
type BootstraplessSynthesizerProps struct {
CloudFormationExecutionRoleArn *string `field:"optional" json:"cloudFormationExecutionRoleArn" yaml:"cloudFormationExecutionRoleArn"`
DeployRoleArn *string `field:"optional" json:"deployRoleArn" yaml:"deployRoleArn"`
Qualifier *string `field:"optional" json:"qualifier" yaml:"qualifier"`
}
Construction properties of `BootstraplessSynthesizer`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
bootstraplessSynthesizerProps := &BootstraplessSynthesizerProps{
CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
DeployRoleArn: jsii.String("deployRoleArn"),
Qualifier: jsii.String("qualifier"),
}
type BundlingFileAccess string
The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.
Example:
go.NewGoFunction(this, jsii.String("GoFunction"), &GoFunctionProps{
Entry: jsii.String("app/cmd/api"),
Bundling: &BundlingOptions{
BundlingFileAccess: awscdk.BundlingFileAccess_VOLUME_COPY,
},
})
const ( BundlingFileAccess_VOLUME_COPY BundlingFileAccess = "VOLUME_COPY" BundlingFileAccess_BIND_MOUNT BundlingFileAccess = "BIND_MOUNT" )
type BundlingOptions struct {
Image DockerImage `field:"required" json:"image" yaml:"image"`
BundlingFileAccess BundlingFileAccess `field:"optional" json:"bundlingFileAccess" yaml:"bundlingFileAccess"`
Command *[]*string `field:"optional" json:"command" yaml:"command"`
Entrypoint *[]*string `field:"optional" json:"entrypoint" yaml:"entrypoint"`
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
Local ILocalBundling `field:"optional" json:"local" yaml:"local"`
Network *string `field:"optional" json:"network" yaml:"network"`
OutputType BundlingOutput `field:"optional" json:"outputType" yaml:"outputType"`
Platform *string `field:"optional" json:"platform" yaml:"platform"`
SecurityOpt *string `field:"optional" json:"securityOpt" yaml:"securityOpt"`
User *string `field:"optional" json:"user" yaml:"user"`
Volumes *[]*DockerVolume `field:"optional" json:"volumes" yaml:"volumes"`
VolumesFrom *[]*string `field:"optional" json:"volumesFrom" yaml:"volumesFrom"`
WorkingDirectory *string `field:"optional" json:"workingDirectory" yaml:"workingDirectory"`
}
Bundling options.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
asset := awscdk.NewAsset(this, jsii.String("BundledAsset"), &AssetProps{
Path: jsii.String("/path/to/asset"),
Bundling: &BundlingOptions{
Image: cdk.DockerImage_FromRegistry(jsii.String("alpine")),
Command: []*string{
jsii.String("command-that-produces-an-archive.sh"),
},
OutputType: cdk.BundlingOutput_NOT_ARCHIVED,
},
})
The type of output that a bundling operation is producing.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
asset := awscdk.NewAsset(this, jsii.String("BundledAsset"), &AssetProps{
Path: jsii.String("/path/to/asset"),
Bundling: &BundlingOptions{
Image: cdk.DockerImage_FromRegistry(jsii.String("alpine")),
Command: []*string{
jsii.String("command-that-produces-an-archive.sh"),
},
OutputType: cdk.BundlingOutput_NOT_ARCHIVED,
},
})
const ( BundlingOutput_ARCHIVED BundlingOutput = "ARCHIVED" BundlingOutput_NOT_ARCHIVED BundlingOutput = "NOT_ARCHIVED" BundlingOutput_AUTO_DISCOVER BundlingOutput = "AUTO_DISCOVER" BundlingOutput_SINGLE_FILE BundlingOutput = "SINGLE_FILE" )
type CfnAutoScalingReplacingUpdate struct {
WillReplace *bool `field:"optional" json:"willReplace" yaml:"willReplace"`
}
Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.
During replacement, AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation can roll back to the old Auto Scaling group and delete the new Auto Scaling group.
While AWS CloudFormation creates the new group, it doesn't detach or attach any instances. After successfully creating the new Auto Scaling group, AWS CloudFormation deletes the old Auto Scaling group during the cleanup process.
When you set the WillReplace parameter, remember to specify a matching CreationPolicy. If the minimum number of instances (specified by the MinSuccessfulInstancesPercent property) don't signal success within the Timeout period (specified in the CreationPolicy policy), the replacement update fails and AWS CloudFormation rolls back to the old Auto Scaling group.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnAutoScalingReplacingUpdate := &CfnAutoScalingReplacingUpdate{
WillReplace: jsii.Boolean(false),
}
type CfnAutoScalingRollingUpdate struct {
MaxBatchSize *float64 `field:"optional" json:"maxBatchSize" yaml:"maxBatchSize"`
MinActiveInstancesPercent *float64 `field:"optional" json:"minActiveInstancesPercent" yaml:"minActiveInstancesPercent"`
MinInstancesInService *float64 `field:"optional" json:"minInstancesInService" yaml:"minInstancesInService"`
MinSuccessfulInstancesPercent *float64 `field:"optional" json:"minSuccessfulInstancesPercent" yaml:"minSuccessfulInstancesPercent"`
PauseTime *string `field:"optional" json:"pauseTime" yaml:"pauseTime"`
SuspendProcesses *[]*string `field:"optional" json:"suspendProcesses" yaml:"suspendProcesses"`
WaitOnResourceSignals *bool `field:"optional" json:"waitOnResourceSignals" yaml:"waitOnResourceSignals"`
}
To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy.
Rolling updates enable you to specify whether AWS CloudFormation updates instances that are in an Auto Scaling group in batches or all at once.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnAutoScalingRollingUpdate := &CfnAutoScalingRollingUpdate{
MaxBatchSize: jsii.Number(123),
MinActiveInstancesPercent: jsii.Number(123),
MinInstancesInService: jsii.Number(123),
MinSuccessfulInstancesPercent: jsii.Number(123),
PauseTime: jsii.String("pauseTime"),
SuspendProcesses: []*string{
jsii.String("suspendProcesses"),
},
WaitOnResourceSignals: jsii.Boolean(false),
}
type CfnAutoScalingScheduledAction struct {
IgnoreUnmodifiedGroupSizeProperties *bool `field:"optional" json:"ignoreUnmodifiedGroupSizeProperties" yaml:"ignoreUnmodifiedGroupSizeProperties"`
}
With scheduled actions, the group size properties of an Auto Scaling group can change at any time.
When you update a stack with an Auto Scaling group and scheduled action, AWS CloudFormation always sets the group size property values of your Auto Scaling group to the values that are defined in the AWS::AutoScaling::AutoScalingGroup resource of your template, even if a scheduled action is in effect.
If you do not want AWS CloudFormation to change any of the group size property values when you have a scheduled action in effect, use the AutoScalingScheduledAction update policy to prevent AWS CloudFormation from changing the MinSize, MaxSize, or DesiredCapacity properties unless you have modified these values in your template.\
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnAutoScalingScheduledAction := &CfnAutoScalingScheduledAction{
IgnoreUnmodifiedGroupSizeProperties: jsii.Boolean(false),
}
Capabilities that affect whether CloudFormation is allowed to change IAM resources.
const ( CfnCapabilities_NONE CfnCapabilities = "NONE" CfnCapabilities_ANONYMOUS_IAM CfnCapabilities = "ANONYMOUS_IAM" CfnCapabilities_NAMED_IAM CfnCapabilities = "NAMED_IAM" CfnCapabilities_AUTO_EXPAND CfnCapabilities = "AUTO_EXPAND" )
type CfnCodeDeployBlueGreenAdditionalOptions struct {
TerminationWaitTimeInMinutes *float64 `field:"optional" json:"terminationWaitTimeInMinutes" yaml:"terminationWaitTimeInMinutes"`
}
Additional options for the blue/green deployment.
The type of the `CfnCodeDeployBlueGreenHookProps.additionalOptions` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenAdditionalOptions := &CfnCodeDeployBlueGreenAdditionalOptions{
TerminationWaitTimeInMinutes: jsii.Number(123),
}
type CfnCodeDeployBlueGreenApplication struct {
EcsAttributes *CfnCodeDeployBlueGreenEcsAttributes `field:"required" json:"ecsAttributes" yaml:"ecsAttributes"`
Target *CfnCodeDeployBlueGreenApplicationTarget `field:"required" json:"target" yaml:"target"`
}
The application actually being deployed.
Type of the `CfnCodeDeployBlueGreenHookProps.applications` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenApplication := &CfnCodeDeployBlueGreenApplication{
EcsAttributes: &CfnCodeDeployBlueGreenEcsAttributes{
TaskDefinitions: []*string{
jsii.String("taskDefinitions"),
},
TaskSets: []*string{
jsii.String("taskSets"),
},
TrafficRouting: &CfnTrafficRouting{
ProdTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
TargetGroups: []*string{
jsii.String("targetGroups"),
},
TestTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
},
},
Target: &CfnCodeDeployBlueGreenApplicationTarget{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
}
type CfnCodeDeployBlueGreenApplicationTarget struct {
LogicalId *string `field:"required" json:"logicalId" yaml:"logicalId"`
Type *string `field:"required" json:"type" yaml:"type"`
}
Type of the `CfnCodeDeployBlueGreenApplication.target` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenApplicationTarget := &CfnCodeDeployBlueGreenApplicationTarget{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
}
type CfnCodeDeployBlueGreenEcsAttributes struct {
TaskDefinitions *[]*string `field:"required" json:"taskDefinitions" yaml:"taskDefinitions"`
TaskSets *[]*string `field:"required" json:"taskSets" yaml:"taskSets"`
TrafficRouting *CfnTrafficRouting `field:"required" json:"trafficRouting" yaml:"trafficRouting"`
}
The attributes of the ECS Service being deployed.
Type of the `CfnCodeDeployBlueGreenApplication.ecsAttributes` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenEcsAttributes := &CfnCodeDeployBlueGreenEcsAttributes{
TaskDefinitions: []*string{
jsii.String("taskDefinitions"),
},
TaskSets: []*string{
jsii.String("taskSets"),
},
TrafficRouting: &CfnTrafficRouting{
ProdTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
TargetGroups: []*string{
jsii.String("targetGroups"),
},
TestTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
},
}
type CfnCodeDeployBlueGreenHookProps struct {
Applications *[]*CfnCodeDeployBlueGreenApplication `field:"required" json:"applications" yaml:"applications"`
ServiceRole *string `field:"required" json:"serviceRole" yaml:"serviceRole"`
AdditionalOptions *CfnCodeDeployBlueGreenAdditionalOptions `field:"optional" json:"additionalOptions" yaml:"additionalOptions"`
LifecycleEventHooks *CfnCodeDeployBlueGreenLifecycleEventHooks `field:"optional" json:"lifecycleEventHooks" yaml:"lifecycleEventHooks"`
TrafficRoutingConfig *CfnTrafficRoutingConfig `field:"optional" json:"trafficRoutingConfig" yaml:"trafficRoutingConfig"`
}
Construction properties of `CfnCodeDeployBlueGreenHook`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenHookProps := &CfnCodeDeployBlueGreenHookProps{
Applications: []CfnCodeDeployBlueGreenApplication{
&CfnCodeDeployBlueGreenApplication{
EcsAttributes: &CfnCodeDeployBlueGreenEcsAttributes{
TaskDefinitions: []*string{
jsii.String("taskDefinitions"),
},
TaskSets: []*string{
jsii.String("taskSets"),
},
TrafficRouting: &CfnTrafficRouting{
ProdTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
TargetGroups: []*string{
jsii.String("targetGroups"),
},
TestTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
},
},
Target: &CfnCodeDeployBlueGreenApplicationTarget{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
},
},
ServiceRole: jsii.String("serviceRole"),
// the properties below are optional
AdditionalOptions: &CfnCodeDeployBlueGreenAdditionalOptions{
TerminationWaitTimeInMinutes: jsii.Number(123),
},
LifecycleEventHooks: &CfnCodeDeployBlueGreenLifecycleEventHooks{
AfterAllowTestTraffic: jsii.String("afterAllowTestTraffic"),
AfterAllowTraffic: jsii.String("afterAllowTraffic"),
AfterInstall: jsii.String("afterInstall"),
BeforeAllowTraffic: jsii.String("beforeAllowTraffic"),
BeforeInstall: jsii.String("beforeInstall"),
},
TrafficRoutingConfig: &CfnTrafficRoutingConfig{
Type: cdk.CfnTrafficRoutingType_ALL_AT_ONCE,
// the properties below are optional
TimeBasedCanary: &CfnTrafficRoutingTimeBasedCanary{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
},
TimeBasedLinear: &CfnTrafficRoutingTimeBasedLinear{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
},
},
}
type CfnCodeDeployBlueGreenLifecycleEventHooks struct {
AfterAllowTestTraffic *string `field:"optional" json:"afterAllowTestTraffic" yaml:"afterAllowTestTraffic"`
AfterAllowTraffic *string `field:"optional" json:"afterAllowTraffic" yaml:"afterAllowTraffic"`
AfterInstall *string `field:"optional" json:"afterInstall" yaml:"afterInstall"`
BeforeAllowTraffic *string `field:"optional" json:"beforeAllowTraffic" yaml:"beforeAllowTraffic"`
BeforeInstall *string `field:"optional" json:"beforeInstall" yaml:"beforeInstall"`
}
Lifecycle events for blue-green deployments.
The type of the `CfnCodeDeployBlueGreenHookProps.lifecycleEventHooks` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployBlueGreenLifecycleEventHooks := &CfnCodeDeployBlueGreenLifecycleEventHooks{
AfterAllowTestTraffic: jsii.String("afterAllowTestTraffic"),
AfterAllowTraffic: jsii.String("afterAllowTraffic"),
AfterInstall: jsii.String("afterInstall"),
BeforeAllowTraffic: jsii.String("beforeAllowTraffic"),
BeforeInstall: jsii.String("beforeInstall"),
}
type CfnCodeDeployLambdaAliasUpdate struct {
ApplicationName *string `field:"required" json:"applicationName" yaml:"applicationName"`
DeploymentGroupName *string `field:"required" json:"deploymentGroupName" yaml:"deploymentGroupName"`
AfterAllowTrafficHook *string `field:"optional" json:"afterAllowTrafficHook" yaml:"afterAllowTrafficHook"`
BeforeAllowTrafficHook *string `field:"optional" json:"beforeAllowTrafficHook" yaml:"beforeAllowTrafficHook"`
}
To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCodeDeployLambdaAliasUpdate := &CfnCodeDeployLambdaAliasUpdate{
ApplicationName: jsii.String("applicationName"),
DeploymentGroupName: jsii.String("deploymentGroupName"),
// the properties below are optional
AfterAllowTrafficHook: jsii.String("afterAllowTrafficHook"),
BeforeAllowTrafficHook: jsii.String("beforeAllowTrafficHook"),
}
Represents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.
Example:
rawBucket := s3.NewCfnBucket(this, jsii.String("Bucket"), &CfnBucketProps{
})
// -or-
rawBucketAlt := myBucket.Node.defaultChild.(CfnBucket)
// then
rawBucket.CfnOptions.Condition = awscdk.NewCfnCondition(this, jsii.String("EnableBucket"), &CfnConditionProps{
})
rawBucket.CfnOptions.Metadata = map[string]interface{}{
"metadataKey": jsii.String("MetadataValue"),
}
Build a new condition.
The condition must be constructed with a condition token, that the condition is based on.
type CfnConditionProps struct {
Expression ICfnConditionExpression `field:"optional" json:"expression" yaml:"expression"`
}
Example:
rawBucket := s3.NewCfnBucket(this, jsii.String("Bucket"), &CfnBucketProps{
})
// -or-
rawBucketAlt := myBucket.Node.defaultChild.(CfnBucket)
// then
rawBucket.CfnOptions.Condition = awscdk.NewCfnCondition(this, jsii.String("EnableBucket"), &CfnConditionProps{
})
rawBucket.CfnOptions.Metadata = map[string]interface{}{
"metadataKey": jsii.String("MetadataValue"),
}
type CfnCreationPolicy struct {
AutoScalingCreationPolicy *CfnResourceAutoScalingCreationPolicy `field:"optional" json:"autoScalingCreationPolicy" yaml:"autoScalingCreationPolicy"`
ResourceSignal *CfnResourceSignal `field:"optional" json:"resourceSignal" yaml:"resourceSignal"`
StartFleet *bool `field:"optional" json:"startFleet" yaml:"startFleet"`
}
Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded.
To signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent.
The creation policy is invoked only when AWS CloudFormation creates the associated resource. Currently, the only AWS CloudFormation resources that support creation policies are AWS::AutoScaling::AutoScalingGroup, AWS::EC2::Instance, AWS::CloudFormation::WaitCondition and AWS::AppStream::Fleet.
Use the CreationPolicy attribute when you want to wait on resource configuration actions before stack creation proceeds. For example, if you install and configure software applications on an EC2 instance, you might want those applications to be running before proceeding. In such cases, you can add a CreationPolicy attribute to the instance, and then send a success signal to the instance after the applications are installed and configured. For a detailed example, see Deploying Applications on Amazon EC2 with AWS CloudFormation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCreationPolicy := &CfnCreationPolicy{
AutoScalingCreationPolicy: &CfnResourceAutoScalingCreationPolicy{
MinSuccessfulInstancesPercent: jsii.Number(123),
},
ResourceSignal: &CfnResourceSignal{
Count: jsii.Number(123),
Timeout: jsii.String("timeout"),
},
StartFleet: jsii.Boolean(false),
}
The `AWS::CloudFormation::CustomResource` resource creates a custom resource.
Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.
For more information, see [Create custom provisioning logic with custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) in the *CloudFormation User Guide* .
> If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Access CloudFormation using an interface endpoint ( AWS PrivateLink )](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCustomResource := cdk.NewCfnCustomResource(this, jsii.String("MyCfnCustomResource"), &CfnCustomResourceProps{
ServiceToken: jsii.String("serviceToken"),
// the properties below are optional
ServiceTimeout: jsii.Number(123),
})
Create a new `AWS::CloudFormation::CustomResource`.
type CfnCustomResourceProps struct {
ServiceToken *string `field:"required" json:"serviceToken" yaml:"serviceToken"`
ServiceTimeout *float64 `field:"optional" json:"serviceTimeout" yaml:"serviceTimeout"`
}
Properties for defining a `CfnCustomResource`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnCustomResourceProps := &CfnCustomResourceProps{
ServiceToken: jsii.String("serviceToken"),
// the properties below are optional
ServiceTimeout: jsii.Number(123),
}
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed.
const ( CfnDeletionPolicy_DELETE CfnDeletionPolicy = "DELETE" CfnDeletionPolicy_RETAIN CfnDeletionPolicy = "RETAIN" CfnDeletionPolicy_RETAIN_EXCEPT_ON_CREATE CfnDeletionPolicy = "RETAIN_EXCEPT_ON_CREATE" CfnDeletionPolicy_SNAPSHOT CfnDeletionPolicy = "SNAPSHOT" )
type CfnDynamicReference interface {
Intrinsic
CreationStack() *[]*string
TypeHint() ResolutionTypeHint
NewError(message *string) interface{}
Resolve(context IResolveContext) interface{}
ToJSON() interface{}
ToString() *string
ToStringList() *[]*string
}
References a dynamically retrieved value.
This is a Construct so that subclasses will (eventually) be able to attach metadata to themselves without having to change call signatures.
Example:
awscdk.NewCfnDynamicReference(awscdk.CfnDynamicReferenceService_SECRETS_MANAGER, jsii.String("secret-id:secret-string:json-key:version-stage:version-id"))
See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html
type CfnDynamicReferenceProps struct {
ReferenceKey *string `field:"required" json:"referenceKey" yaml:"referenceKey"`
Service CfnDynamicReferenceService `field:"required" json:"service" yaml:"service"`
}
Properties for a Dynamic Reference.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnDynamicReferenceProps := &CfnDynamicReferenceProps{
ReferenceKey: jsii.String("referenceKey"),
Service: cdk.CfnDynamicReferenceService_SSM,
}
type CfnDynamicReferenceService string
The service to retrieve the dynamic reference from.
Example:
awscdk.NewCfnDynamicReference(awscdk.CfnDynamicReferenceService_SECRETS_MANAGER, jsii.String("secret-id:secret-string:json-key:version-stage:version-id"))
const ( CfnDynamicReferenceService_SSM CfnDynamicReferenceService = "SSM" CfnDynamicReferenceService_SSM_SECURE CfnDynamicReferenceService = "SSM_SECURE" CfnDynamicReferenceService_SECRETS_MANAGER CfnDynamicReferenceService = "SECRETS_MANAGER" )
An element of a CloudFormation stack.
The `AWS::CloudFormation::GuardHook` resource creates and activates a Guard Hook.
Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.
For more information, see [Guard Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/guard-hooks.html) in the *CloudFormation Hooks User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnGuardHook := cdk.NewCfnGuardHook(this, jsii.String("MyCfnGuardHook"), &CfnGuardHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
RuleLocation: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
LogBucket: jsii.String("logBucket"),
Options: &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
})
Create a new `AWS::CloudFormation::GuardHook`.
type CfnGuardHookProps struct {
Alias *string `field:"required" json:"alias" yaml:"alias"`
ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"`
FailureMode *string `field:"required" json:"failureMode" yaml:"failureMode"`
HookStatus *string `field:"required" json:"hookStatus" yaml:"hookStatus"`
RuleLocation interface{} `field:"required" json:"ruleLocation" yaml:"ruleLocation"`
TargetOperations *[]*string `field:"required" json:"targetOperations" yaml:"targetOperations"`
LogBucket *string `field:"optional" json:"logBucket" yaml:"logBucket"`
Options interface{} `field:"optional" json:"options" yaml:"options"`
StackFilters interface{} `field:"optional" json:"stackFilters" yaml:"stackFilters"`
TargetFilters interface{} `field:"optional" json:"targetFilters" yaml:"targetFilters"`
}
Properties for defining a `CfnGuardHook`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnGuardHookProps := &CfnGuardHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
RuleLocation: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
LogBucket: jsii.String("logBucket"),
Options: &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
}
type CfnGuardHook_HookTargetProperty struct {
Action *string `field:"required" json:"action" yaml:"action"`
InvocationPoint *string `field:"required" json:"invocationPoint" yaml:"invocationPoint"`
TargetName *string `field:"required" json:"targetName" yaml:"targetName"`
}
Hook targets are the destination where hooks will be invoked against.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
hookTargetProperty := &HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
}
type CfnGuardHook_OptionsProperty struct {
InputParams interface{} `field:"optional" json:"inputParams" yaml:"inputParams"`
}
Specifies the input parameters for a Guard Hook.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
optionsProperty := &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
}
type CfnGuardHook_S3LocationProperty struct {
Uri *string `field:"required" json:"uri" yaml:"uri"`
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Specifies the S3 location where your Guard rules or input parameters are located.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
s3LocationProperty := &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
}
type CfnGuardHook_StackFiltersProperty struct {
FilteringCriteria *string `field:"required" json:"filteringCriteria" yaml:"filteringCriteria"`
StackNames interface{} `field:"optional" json:"stackNames" yaml:"stackNames"`
StackRoles interface{} `field:"optional" json:"stackRoles" yaml:"stackRoles"`
}
The `StackFilters` property type specifies stack level filters for a Hook.
The `StackNames` or `StackRoles` properties are optional. However, you must specify at least one of these properties.
For more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
stackFiltersProperty := &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
}
type CfnGuardHook_TargetFiltersProperty struct {
Targets interface{} `field:"required" json:"targets" yaml:"targets"`
Actions *[]*string `field:"optional" json:"actions" yaml:"actions"`
InvocationPoints *[]*string `field:"optional" json:"invocationPoints" yaml:"invocationPoints"`
TargetNames *[]*string `field:"optional" json:"targetNames" yaml:"targetNames"`
}
The `TargetFilters` property type specifies the target filters for the Hook.
For more information, see [CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
targetFiltersProperty := &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
}
Represents a CloudFormation resource.
Example:
var cfnTemplate CfnInclude
// mutating the hook
var myRole Role
hook := cfnTemplate.GetHook(jsii.String("MyOutput"))
codeDeployHook := hook.(CfnCodeDeployBlueGreenHook)
codeDeployHook.serviceRole = myRole.roleArn
Creates a new Hook object.
The `AWS::CloudFormation::HookDefaultVersion` resource specifies the default version of a Hook.
The default version of the Hook is used in CloudFormation operations for this AWS account and AWS Region .
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
This resource type is not compatible with Guard and Lambda Hooks.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookDefaultVersion := cdk.NewCfnHookDefaultVersion(this, jsii.String("MyCfnHookDefaultVersion"), &CfnHookDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
})
Create a new `AWS::CloudFormation::HookDefaultVersion`.
type CfnHookDefaultVersionProps struct {
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
TypeVersionArn *string `field:"optional" json:"typeVersionArn" yaml:"typeVersionArn"`
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnHookDefaultVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookDefaultVersionProps := &CfnHookDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
}
type CfnHookProps struct {
Type *string `field:"required" json:"type" yaml:"type"`
Properties *map[string]interface{} `field:"optional" json:"properties" yaml:"properties"`
}
Construction properties of `CfnHook`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var properties interface{}
cfnHookProps := &CfnHookProps{
Type: jsii.String("type"),
// the properties below are optional
Properties: map[string]interface{}{
"propertiesKey": properties,
},
}
The `AWS::CloudFormation::HookTypeConfig` resource specifies the configuration of an activated Hook.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookTypeConfig := cdk.NewCfnHookTypeConfig(this, jsii.String("MyCfnHookTypeConfig"), &CfnHookTypeConfigProps{
Configuration: jsii.String("configuration"),
// the properties below are optional
ConfigurationAlias: jsii.String("configurationAlias"),
TypeArn: jsii.String("typeArn"),
TypeName: jsii.String("typeName"),
})
Create a new `AWS::CloudFormation::HookTypeConfig`.
type CfnHookTypeConfigProps struct {
Configuration *string `field:"required" json:"configuration" yaml:"configuration"`
ConfigurationAlias *string `field:"optional" json:"configurationAlias" yaml:"configurationAlias"`
TypeArn *string `field:"optional" json:"typeArn" yaml:"typeArn"`
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
}
Properties for defining a `CfnHookTypeConfig`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookTypeConfigProps := &CfnHookTypeConfigProps{
Configuration: jsii.String("configuration"),
// the properties below are optional
ConfigurationAlias: jsii.String("configurationAlias"),
TypeArn: jsii.String("typeArn"),
TypeName: jsii.String("typeName"),
}
The `AWS::CloudFormation::HookVersion` resource publishes new or first version of a Hook to the CloudFormation registry.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
This resource type is not compatible with Guard and Lambda Hooks.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookVersion := cdk.NewCfnHookVersion(this, jsii.String("MyCfnHookVersion"), &CfnHookVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
})
Create a new `AWS::CloudFormation::HookVersion`.
type CfnHookVersionProps struct {
SchemaHandlerPackage *string `field:"required" json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
TypeName *string `field:"required" json:"typeName" yaml:"typeName"`
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
}
Properties for defining a `CfnHookVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnHookVersionProps := &CfnHookVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
}
type CfnHookVersion_LoggingConfigProperty struct {
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
The `LoggingConfig` property type specifies logging configuration information for an extension.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.
The main use case for this is to overcome a limitation in CloudFormation that does not allow using intrinsic functions as dictionary keys (because dictionary keys in JSON must be strings). Specifically this is common in IAM conditions such as `StringEquals: { lhs: "rhs" }` where you want "lhs" to be a reference.
This object is resolvable, so it can be used as a value.
This construct is backed by a custom resource.
Example:
tagParam := awscdk.NewCfnParameter(this, jsii.String("TagName"))
stringEquals := awscdk.NewCfnJson(this, jsii.String("ConditionJson"), &CfnJsonProps{
Value: map[string]*bool{
fmt.Sprintf("aws:PrincipalTag/%v", tagParam.valueAsString): jsii.Boolean(true),
},
})
principal := iam.NewAccountRootPrincipal().WithConditions(map[string]interface{}{
"StringEquals": stringEquals,
})
iam.NewRole(this, jsii.String("MyRole"), &RoleProps{
AssumedBy: principal,
})
type CfnJsonProps struct {
Value interface{} `field:"required" json:"value" yaml:"value"`
}
Example:
tagParam := awscdk.NewCfnParameter(this, jsii.String("TagName"))
stringEquals := awscdk.NewCfnJson(this, jsii.String("ConditionJson"), &CfnJsonProps{
Value: map[string]*bool{
fmt.Sprintf("aws:PrincipalTag/%v", tagParam.valueAsString): jsii.Boolean(true),
},
})
principal := iam.NewAccountRootPrincipal().WithConditions(map[string]interface{}{
"StringEquals": stringEquals,
})
iam.NewRole(this, jsii.String("MyRole"), &RoleProps{
AssumedBy: principal,
})
The `AWS::CloudFormation::LambdaHook` resource creates and activates a Lambda Hook.
You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.
For more information, see [Lambda Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/lambda-hooks.html) in the *CloudFormation Hooks User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnLambdaHook := cdk.NewCfnLambdaHook(this, jsii.String("MyCfnLambdaHook"), &CfnLambdaHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
LambdaFunction: jsii.String("lambdaFunction"),
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
})
Create a new `AWS::CloudFormation::LambdaHook`.
type CfnLambdaHookProps struct {
Alias *string `field:"required" json:"alias" yaml:"alias"`
ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"`
FailureMode *string `field:"required" json:"failureMode" yaml:"failureMode"`
HookStatus *string `field:"required" json:"hookStatus" yaml:"hookStatus"`
LambdaFunction *string `field:"required" json:"lambdaFunction" yaml:"lambdaFunction"`
TargetOperations *[]*string `field:"required" json:"targetOperations" yaml:"targetOperations"`
StackFilters interface{} `field:"optional" json:"stackFilters" yaml:"stackFilters"`
TargetFilters interface{} `field:"optional" json:"targetFilters" yaml:"targetFilters"`
}
Properties for defining a `CfnLambdaHook`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnLambdaHookProps := &CfnLambdaHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
LambdaFunction: jsii.String("lambdaFunction"),
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
}
type CfnLambdaHook_HookTargetProperty struct {
Action *string `field:"required" json:"action" yaml:"action"`
InvocationPoint *string `field:"required" json:"invocationPoint" yaml:"invocationPoint"`
TargetName *string `field:"required" json:"targetName" yaml:"targetName"`
}
Hook targets are the destination where hooks will be invoked against.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
hookTargetProperty := &HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
}
type CfnLambdaHook_StackFiltersProperty struct {
FilteringCriteria *string `field:"required" json:"filteringCriteria" yaml:"filteringCriteria"`
StackNames interface{} `field:"optional" json:"stackNames" yaml:"stackNames"`
StackRoles interface{} `field:"optional" json:"stackRoles" yaml:"stackRoles"`
}
The `StackFilters` property type specifies stack level filters for a Hook.
The `StackNames` or `StackRoles` properties are optional. However, you must specify at least one of these properties.
For more information, see [CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
stackFiltersProperty := &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
}
type CfnLambdaHook_TargetFiltersProperty struct {
Targets interface{} `field:"required" json:"targets" yaml:"targets"`
Actions *[]*string `field:"optional" json:"actions" yaml:"actions"`
InvocationPoints *[]*string `field:"optional" json:"invocationPoints" yaml:"invocationPoints"`
TargetNames *[]*string `field:"optional" json:"targetNames" yaml:"targetNames"`
}
The `TargetFilters` property type specifies the target filters for the Hook.
For more information, see [CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
targetFiltersProperty := &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
}
The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.
For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnMacro := cdk.NewCfnMacro(this, jsii.String("MyCfnMacro"), &CfnMacroProps{
FunctionName: jsii.String("functionName"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
Create a new `AWS::CloudFormation::Macro`.
type CfnMacroProps struct {
FunctionName *string `field:"required" json:"functionName" yaml:"functionName"`
Name *string `field:"required" json:"name" yaml:"name"`
Description *string `field:"optional" json:"description" yaml:"description"`
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Properties for defining a `CfnMacro`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnMacroProps := &CfnMacroProps{
FunctionName: jsii.String("functionName"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
Represents a CloudFormation mapping.
Example:
regionTable := awscdk.NewCfnMapping(this, jsii.String("RegionTable"), &CfnMappingProps{
Mapping: map[string]map[string]interface{}{
"us-east-1": map[string]interface{}{
"regionName": jsii.String("US East (N. Virginia)"),
},
"us-east-2": map[string]interface{}{
"regionName": jsii.String("US East (Ohio)"),
},
},
})
regionTable.FindInMap(awscdk.Aws_REGION(), jsii.String("regionName"))
type CfnMappingProps struct {
Lazy *bool `field:"optional" json:"lazy" yaml:"lazy"`
Mapping *map[string]*map[string]interface{} `field:"optional" json:"mapping" yaml:"mapping"`
}
Example:
regionTable := awscdk.NewCfnMapping(this, jsii.String("RegionTable"), &CfnMappingProps{
Mapping: map[string]map[string]interface{}{
"us-east-1": map[string]interface{}{
"regionName": jsii.String("US East (N. Virginia)"),
},
"us-east-2": map[string]interface{}{
"regionName": jsii.String("US East (Ohio)"),
},
},
Lazy: jsii.Boolean(true),
})
regionTable.FindInMap(jsii.String("us-east-2"), jsii.String("regionName"))
type CfnModuleDefaultVersionProps struct {
Arn interface{} `field:"optional" json:"arn" yaml:"arn"`
ModuleName *string `field:"optional" json:"moduleName" yaml:"moduleName"`
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnModuleDefaultVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnModuleDefaultVersionProps := &CfnModuleDefaultVersionProps{
Arn: jsii.String("arn"),
ModuleName: jsii.String("moduleName"),
VersionId: jsii.String("versionId"),
}
type CfnModuleVersionProps struct {
ModuleName *string `field:"required" json:"moduleName" yaml:"moduleName"`
ModulePackage *string `field:"required" json:"modulePackage" yaml:"modulePackage"`
}
Properties for defining a `CfnModuleVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnModuleVersionProps := &CfnModuleVersionProps{
ModuleName: jsii.String("moduleName"),
ModulePackage: jsii.String("modulePackage"),
}
Example:
import s3 "github.com/aws/aws-cdk-go/awscdk"
var cluster Cluster
// add service account
serviceAccount := cluster.addServiceAccount(jsii.String("MyServiceAccount"))
bucket := s3.NewBucket(this, jsii.String("Bucket"))
bucket.GrantReadWrite(serviceAccount)
mypod := cluster.addManifest(jsii.String("mypod"), map[string]interface{}{
"apiVersion": jsii.String("v1"),
"kind": jsii.String("Pod"),
"metadata": map[string]*string{
"name": jsii.String("mypod"),
},
"spec": map[string]interface{}{
"serviceAccountName": serviceAccount.serviceAccountName,
"containers": []map[string]interface{}{
map[string]interface{}{
"name": jsii.String("hello"),
"image": jsii.String("paulbouwer/hello-kubernetes:1.5"),
"ports": []map[string]*f64{
map[string]*f64{
"containerPort": jsii.Number(8080),
},
},
},
},
},
})
// create the resource after the service account.
mypod.Node.AddDependency(serviceAccount)
// print the IAM role arn for this service account
// print the IAM role arn for this service account
awscdk.NewCfnOutput(this, jsii.String("ServiceAccountIamRole"), &CfnOutputProps{
Value: serviceAccount.Role.RoleArn,
})
Creates a CfnOutput value for this stack.
type CfnOutputProps struct {
Value *string `field:"required" json:"value" yaml:"value"`
Condition CfnCondition `field:"optional" json:"condition" yaml:"condition"`
Description *string `field:"optional" json:"description" yaml:"description"`
ExportName *string `field:"optional" json:"exportName" yaml:"exportName"`
Key *string `field:"optional" json:"key" yaml:"key"`
}
Example:
import s3 "github.com/aws/aws-cdk-go/awscdk"
var cluster Cluster
// add service account
serviceAccount := cluster.addServiceAccount(jsii.String("MyServiceAccount"))
bucket := s3.NewBucket(this, jsii.String("Bucket"))
bucket.GrantReadWrite(serviceAccount)
mypod := cluster.addManifest(jsii.String("mypod"), map[string]interface{}{
"apiVersion": jsii.String("v1"),
"kind": jsii.String("Pod"),
"metadata": map[string]*string{
"name": jsii.String("mypod"),
},
"spec": map[string]interface{}{
"serviceAccountName": serviceAccount.serviceAccountName,
"containers": []map[string]interface{}{
map[string]interface{}{
"name": jsii.String("hello"),
"image": jsii.String("paulbouwer/hello-kubernetes:1.5"),
"ports": []map[string]*f64{
map[string]*f64{
"containerPort": jsii.Number(8080),
},
},
},
},
},
})
// create the resource after the service account.
mypod.Node.AddDependency(serviceAccount)
// print the IAM role arn for this service account
// print the IAM role arn for this service account
awscdk.NewCfnOutput(this, jsii.String("ServiceAccountIamRole"), &CfnOutputProps{
Value: serviceAccount.Role.RoleArn,
})
A CloudFormation parameter.
Use the optional Parameters section to customize your templates. Parameters enable you to input custom values to your template each time you create or update a stack.
Example:
myTopic := sns.NewTopic(this, jsii.String("MyTopic"))
url := awscdk.NewCfnParameter(this, jsii.String("url-param"))
myTopic.AddSubscription(subscriptions.NewUrlSubscription(url.valueAsString))
Creates a parameter construct.
Note that the name (logical ID) of the parameter will derive from it's `coname` and location within the stack. Therefore, it is recommended that parameters are defined at the stack level.
type CfnParameterProps struct {
AllowedPattern *string `field:"optional" json:"allowedPattern" yaml:"allowedPattern"`
AllowedValues *[]*string `field:"optional" json:"allowedValues" yaml:"allowedValues"`
ConstraintDescription *string `field:"optional" json:"constraintDescription" yaml:"constraintDescription"`
Default interface{} `field:"optional" json:"default" yaml:"default"`
Description *string `field:"optional" json:"description" yaml:"description"`
MaxLength *float64 `field:"optional" json:"maxLength" yaml:"maxLength"`
MaxValue *float64 `field:"optional" json:"maxValue" yaml:"maxValue"`
MinLength *float64 `field:"optional" json:"minLength" yaml:"minLength"`
MinValue *float64 `field:"optional" json:"minValue" yaml:"minValue"`
NoEcho *bool `field:"optional" json:"noEcho" yaml:"noEcho"`
Type *string `field:"optional" json:"type" yaml:"type"`
}
Example:
stack := awscdk.Newstack()
durToken := awscdk.NewCfnParameter(stack, jsii.String("MyParameter"), &CfnParameterProps{
Type: jsii.String("Number"),
Default: jsii.Number(60),
})
awscdk.NewCustomResource(stack, jsii.String("MyCustomResource"), &CustomResourceProps{
ServiceToken: jsii.String("MyServiceToken"),
ServiceTimeout: awscdk.Duration_Seconds(durToken.valueAsNumber),
})
The `AWS::CloudFormation::PublicTypeVersion` resource tests and publishes a registered extension as a public, third-party extension.
CloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users.
- For resource types, testing includes passing all contracts tests defined for the type. - For modules, testing includes determining if the module's model meets all necessary requirements.
For more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation Command Line Interface (CLI) User Guide* .
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered.
An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the *CloudFormation Command Line Interface (CLI) User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnPublicTypeVersion := cdk.NewCfnPublicTypeVersion(this, jsii.String("MyCfnPublicTypeVersion"), &CfnPublicTypeVersionProps{
Arn: jsii.String("arn"),
LogDeliveryBucket: jsii.String("logDeliveryBucket"),
PublicVersionNumber: jsii.String("publicVersionNumber"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
})
Create a new `AWS::CloudFormation::PublicTypeVersion`.
type CfnPublicTypeVersionProps struct {
Arn *string `field:"optional" json:"arn" yaml:"arn"`
LogDeliveryBucket *string `field:"optional" json:"logDeliveryBucket" yaml:"logDeliveryBucket"`
PublicVersionNumber *string `field:"optional" json:"publicVersionNumber" yaml:"publicVersionNumber"`
Type *string `field:"optional" json:"type" yaml:"type"`
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
}
Properties for defining a `CfnPublicTypeVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnPublicTypeVersionProps := &CfnPublicTypeVersionProps{
Arn: jsii.String("arn"),
LogDeliveryBucket: jsii.String("logDeliveryBucket"),
PublicVersionNumber: jsii.String("publicVersionNumber"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
}
The `AWS::CloudFormation::Publisher` resource registers your account as a publisher of public extensions in the CloudFormation registry.
Public extensions are available for use by all CloudFormation users.
For information on requirements for registering as a public extension publisher, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.htm) in the *CloudFormation Command Line Interface (CLI) User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnPublisher := cdk.NewCfnPublisher(this, jsii.String("MyCfnPublisher"), &CfnPublisherProps{
AcceptTermsAndConditions: jsii.Boolean(false),
// the properties below are optional
ConnectionArn: jsii.String("connectionArn"),
})
Create a new `AWS::CloudFormation::Publisher`.
type CfnPublisherProps struct {
AcceptTermsAndConditions interface{} `field:"required" json:"acceptTermsAndConditions" yaml:"acceptTermsAndConditions"`
ConnectionArn *string `field:"optional" json:"connectionArn" yaml:"connectionArn"`
}
Properties for defining a `CfnPublisher`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnPublisherProps := &CfnPublisherProps{
AcceptTermsAndConditions: jsii.Boolean(false),
// the properties below are optional
ConnectionArn: jsii.String("connectionArn"),
}
Base class for referenceable CloudFormation constructs which are not Resources.
These constructs are things like Conditions and Parameters, can be referenced by taking the `.ref` attribute.
Resource constructs do not inherit from CfnRefElement because they have their own, more specific types returned from the .ref attribute. Also, some resources aren't referenceable at all (such as BucketPolicies or GatewayAttachments).
type CfnResource interface {
CfnRefElement
CfnOptions() ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
LogicalId() *string
Node() constructs.Node
Ref() *string
Stack() Stack
UpdatedProperites() *map[string]interface{}
UpdatedProperties() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependency(target CfnResource)
AddDependsOn(target CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
GetAtt(attributeName *string, typeHint ResolutionTypeHint) Reference
GetMetadata(key *string) interface{}
ObtainDependencies() *[]interface{}
ObtainResourceDependencies() *[]CfnResource
OverrideLogicalId(newLogicalId *string)
RemoveDependency(target CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ReplaceDependency(target CfnResource, newTarget CfnResource)
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Represents a CloudFormation resource.
Example:
type myConstruct struct {
Resource
tags
}
func newMyConstruct(scope Construct, id *string) *myConstruct {
this := &myConstruct{}
newResource_Override(this, scope, id)
awscdk.NewCfnResource(this, jsii.String("Resource"), &CfnResourceProps{
Type: jsii.String("Whatever::The::Type"),
Properties: map[string]interface{}{
// ...
"Tags": this.tags.renderedTags,
},
})
return this
}
Creates a resource construct.
type CfnResourceAutoScalingCreationPolicy struct {
MinSuccessfulInstancesPercent *float64 `field:"optional" json:"minSuccessfulInstancesPercent" yaml:"minSuccessfulInstancesPercent"`
}
For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnResourceAutoScalingCreationPolicy := &CfnResourceAutoScalingCreationPolicy{
MinSuccessfulInstancesPercent: jsii.Number(123),
}
The `AWS::CloudFormation::ResourceDefaultVersion` resource specifies the default version of a resource.
The default version of a resource will be used in CloudFormation operations.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnResourceDefaultVersion := cdk.NewCfnResourceDefaultVersion(this, jsii.String("MyCfnResourceDefaultVersion"), &CfnResourceDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
})
Create a new `AWS::CloudFormation::ResourceDefaultVersion`.
type CfnResourceDefaultVersionProps struct {
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
TypeVersionArn interface{} `field:"optional" json:"typeVersionArn" yaml:"typeVersionArn"`
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnResourceDefaultVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnResourceDefaultVersionProps := &CfnResourceDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
}
type CfnResourceProps struct {
Type *string `field:"required" json:"type" yaml:"type"`
Properties *map[string]interface{} `field:"optional" json:"properties" yaml:"properties"`
}
Example:
type myConstruct struct {
Resource
tags
}
func newMyConstruct(scope Construct, id *string) *myConstruct {
this := &myConstruct{}
newResource_Override(this, scope, id)
awscdk.NewCfnResource(this, jsii.String("Resource"), &CfnResourceProps{
Type: jsii.String("Whatever::The::Type"),
Properties: map[string]interface{}{
// ...
"Tags": this.tags.renderedTags,
},
})
return this
}
type CfnResourceSignal struct {
Count *float64 `field:"optional" json:"count" yaml:"count"`
Timeout *string `field:"optional" json:"timeout" yaml:"timeout"`
}
When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.
Example:
var resource CfnResource
resource.CfnOptions.CreationPolicy = &CfnCreationPolicy{
ResourceSignal: &CfnResourceSignal{
Count: jsii.Number(3),
Timeout: jsii.String("PR15M"),
},
}
The `AWS::CloudFormation::ResourceVersion` resource registers a resource version with the CloudFormation registry.
Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:
- Validating the resource schema. - Determining which handlers, if any, have been specified for the resource. - Making the resource available for use in your account.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnResourceVersion := cdk.NewCfnResourceVersion(this, jsii.String("MyCfnResourceVersion"), &CfnResourceVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
})
Create a new `AWS::CloudFormation::ResourceVersion`.
type CfnResourceVersionProps struct {
SchemaHandlerPackage *string `field:"required" json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
TypeName *string `field:"required" json:"typeName" yaml:"typeName"`
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
}
Properties for defining a `CfnResourceVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnResourceVersionProps := &CfnResourceVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
}
type CfnResourceVersion_LoggingConfigProperty struct {
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Logging configuration information for a resource.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
The Rules that define template constraints in an AWS Service Catalog portfolio describe when end users can use the template and which values they can specify for parameters that are declared in the AWS CloudFormation template used to create the product they are attempting to use.
Rules are useful for preventing end users from inadvertently specifying an incorrect value. For example, you can add a rule to verify whether end users specified a valid subnet in a given VPC or used m1.small instance types for test environments. AWS CloudFormation uses rules to validate parameter values before it creates the resources for the product.
A rule can include a RuleCondition property and must include an Assertions property. For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property. You define a rule condition and assertions by using rule-specific intrinsic functions.
Example:
var cfnTemplate CfnInclude
// mutating the rule
var myParameter CfnParameter
rule := cfnTemplate.GetRule(jsii.String("MyRule"))
rule.AddAssertion(core.Fn_ConditionContains([]*string{
jsii.String("m1.small"),
}, myParameter.valueAsString), jsii.String("MyParameter has to be m1.small"))
type CfnRuleAssertion struct {
Assert ICfnConditionExpression `field:"required" json:"assert" yaml:"assert"`
AssertDescription *string `field:"required" json:"assertDescription" yaml:"assertDescription"`
}
A rule assertion.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var cfnConditionExpression ICfnConditionExpression
cfnRuleAssertion := &CfnRuleAssertion{
Assert: cfnConditionExpression,
AssertDescription: jsii.String("assertDescription"),
}
type CfnRuleProps struct {
Assertions *[]*CfnRuleAssertion `field:"optional" json:"assertions" yaml:"assertions"`
RuleCondition ICfnConditionExpression `field:"optional" json:"ruleCondition" yaml:"ruleCondition"`
}
A rule can include a RuleCondition property and must include an Assertions property.
For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property. You define a rule condition and assertions by using rule-specific intrinsic functions.
You can use the following rule-specific intrinsic functions to define rule conditions and assertions:
Fn::And Fn::Contains Fn::EachMemberEquals Fn::EachMemberIn Fn::Equals Fn::If Fn::Not Fn::Or Fn::RefAll Fn::ValueOf Fn::ValueOfAll
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var cfnConditionExpression ICfnConditionExpression
cfnRuleProps := &CfnRuleProps{
Assertions: []CfnRuleAssertion{
&CfnRuleAssertion{
Assert: cfnConditionExpression,
AssertDescription: jsii.String("assertDescription"),
},
},
RuleCondition: cfnConditionExpression,
}
The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template.
For more information, see [Nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) in the *CloudFormation User Guide* .
You can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` .
We strongly recommend that updates to nested stacks are run from the parent stack.
When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.
For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html) in the *CloudFormation User Guide* .
> A subset of `AWS::CloudFormation::Stack` resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control to configure. > > - `NotificationARNs` > - `Parameters` > - `Tags` > - `TemplateURL` > - `TimeoutInMinutes` > > These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control . > > - `Capabilities` > - `Description` > - `DisableRollback` > - `EnableTerminationProtection` > - `RoleARN` > - `StackName` > - `StackPolicyBody` > - `StackPolicyURL` > - `StackStatusReason` > - `TemplateBody` > > Customers that configure `AWS::CloudFormation::Stack` using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template. > > These read-only properties can be accessed only when using Cloud Control . > > - `ChangeSetId` > - `CreationTime` > - `LastUpdateTime` > - `Outputs` > - `ParentId` > - `RootId` > - `StackId` > - `StackStatus`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnStack := cdk.NewCfnStack(this, jsii.String("MyCfnStack"), &CfnStackProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateUrl: jsii.String("templateUrl"),
TimeoutInMinutes: jsii.Number(123),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html
Create a new `AWS::CloudFormation::Stack`.
type CfnStackProps struct {
NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"`
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
Tags *[]*CfnTag `field:"optional" json:"tags" yaml:"tags"`
TemplateUrl *string `field:"optional" json:"templateUrl" yaml:"templateUrl"`
TimeoutInMinutes *float64 `field:"optional" json:"timeoutInMinutes" yaml:"timeoutInMinutes"`
}
Properties for defining a `CfnStack`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnStackProps := &CfnStackProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateUrl: jsii.String("templateUrl"),
TimeoutInMinutes: jsii.Number(123),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html
type CfnStackSet interface {
CfnResource
IInspectable
interfacesawscloudformation.IStackSetRef
ITaggable
AdministrationRoleArn() *string
SetAdministrationRoleArn(val *string)
AttrStackSetId() *string
AutoDeployment() interface{}
SetAutoDeployment(val interface{})
CallAs() *string
SetCallAs(val *string)
Capabilities() *[]*string
SetCapabilities(val *[]*string)
CfnOptions() ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
ExecutionRoleName() *string
SetExecutionRoleName(val *string)
LogicalId() *string
ManagedExecution() interface{}
SetManagedExecution(val interface{})
Node() constructs.Node
OperationPreferences() interface{}
SetOperationPreferences(val interface{})
Parameters() interface{}
SetParameters(val interface{})
PermissionModel() *string
SetPermissionModel(val *string)
Ref() *string
Stack() Stack
StackInstancesGroup() interface{}
SetStackInstancesGroup(val interface{})
StackSetName() *string
SetStackSetName(val *string)
StackSetRef() *interfacesawscloudformation.StackSetReference
Tags() TagManager
TagsRaw() *[]*CfnTag
SetTagsRaw(val *[]*CfnTag)
TemplateBody() *string
SetTemplateBody(val *string)
TemplateUrl() *string
SetTemplateUrl(val *string)
UpdatedProperites() *map[string]interface{}
UpdatedProperties() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependency(target CfnResource)
AddDependsOn(target CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions)
GetAtt(attributeName *string, typeHint ResolutionTypeHint) Reference
GetMetadata(key *string) interface{}
Inspect(inspector TreeInspector)
ObtainDependencies() *[]interface{}
ObtainResourceDependencies() *[]CfnResource
OverrideLogicalId(newLogicalId *string)
RemoveDependency(target CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ReplaceDependency(target CfnResource, newTarget CfnResource)
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
With(mixins ...constructs.IMixin) constructs.IConstruct
}
The `AWS::CloudFormation::StackSet` resource contains information about a StackSet.
With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.
> Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var managedExecution interface{}
cfnStackSet := cdk.NewCfnStackSet(this, jsii.String("MyCfnStackSet"), &CfnStackSetProps{
PermissionModel: jsii.String("permissionModel"),
StackSetName: jsii.String("stackSetName"),
// the properties below are optional
AdministrationRoleArn: jsii.String("administrationRoleArn"),
AutoDeployment: &AutoDeploymentProperty{
DependsOn: []*string{
jsii.String("dependsOn"),
},
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
},
CallAs: jsii.String("callAs"),
Capabilities: []*string{
jsii.String("capabilities"),
},
Description: jsii.String("description"),
ExecutionRoleName: jsii.String("executionRoleName"),
ManagedExecution: managedExecution,
OperationPreferences: &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
},
Parameters: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
StackInstancesGroup: []interface{}{
&StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateBody: jsii.String("templateBody"),
TemplateUrl: jsii.String("templateUrl"),
})
Create a new `AWS::CloudFormation::StackSet`.
type CfnStackSetProps struct {
PermissionModel *string `field:"required" json:"permissionModel" yaml:"permissionModel"`
StackSetName *string `field:"required" json:"stackSetName" yaml:"stackSetName"`
AdministrationRoleArn interface{} `field:"optional" json:"administrationRoleArn" yaml:"administrationRoleArn"`
AutoDeployment interface{} `field:"optional" json:"autoDeployment" yaml:"autoDeployment"`
CallAs *string `field:"optional" json:"callAs" yaml:"callAs"`
Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"`
Description *string `field:"optional" json:"description" yaml:"description"`
ExecutionRoleName interface{} `field:"optional" json:"executionRoleName" yaml:"executionRoleName"`
ManagedExecution interface{} `field:"optional" json:"managedExecution" yaml:"managedExecution"`
OperationPreferences interface{} `field:"optional" json:"operationPreferences" yaml:"operationPreferences"`
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
StackInstancesGroup interface{} `field:"optional" json:"stackInstancesGroup" yaml:"stackInstancesGroup"`
Tags *[]*CfnTag `field:"optional" json:"tags" yaml:"tags"`
TemplateBody *string `field:"optional" json:"templateBody" yaml:"templateBody"`
TemplateUrl *string `field:"optional" json:"templateUrl" yaml:"templateUrl"`
}
Properties for defining a `CfnStackSet`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var managedExecution interface{}
cfnStackSetProps := &CfnStackSetProps{
PermissionModel: jsii.String("permissionModel"),
StackSetName: jsii.String("stackSetName"),
// the properties below are optional
AdministrationRoleArn: jsii.String("administrationRoleArn"),
AutoDeployment: &AutoDeploymentProperty{
DependsOn: []*string{
jsii.String("dependsOn"),
},
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
},
CallAs: jsii.String("callAs"),
Capabilities: []*string{
jsii.String("capabilities"),
},
Description: jsii.String("description"),
ExecutionRoleName: jsii.String("executionRoleName"),
ManagedExecution: managedExecution,
OperationPreferences: &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
},
Parameters: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
StackInstancesGroup: []interface{}{
&StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateBody: jsii.String("templateBody"),
TemplateUrl: jsii.String("templateUrl"),
}
type CfnStackSet_AutoDeploymentProperty struct {
DependsOn *[]*string `field:"optional" json:"dependsOn" yaml:"dependsOn"`
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
RetainStacksOnAccountRemoval interface{} `field:"optional" json:"retainStacksOnAccountRemoval" yaml:"retainStacksOnAccountRemoval"`
}
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
For more information, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
autoDeploymentProperty := &AutoDeploymentProperty{
DependsOn: []*string{
jsii.String("dependsOn"),
},
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
}
type CfnStackSet_DeploymentTargetsProperty struct {
AccountFilterType *string `field:"optional" json:"accountFilterType" yaml:"accountFilterType"`
Accounts *[]*string `field:"optional" json:"accounts" yaml:"accounts"`
AccountsUrl *string `field:"optional" json:"accountsUrl" yaml:"accountsUrl"`
OrganizationalUnitIds *[]*string `field:"optional" json:"organizationalUnitIds" yaml:"organizationalUnitIds"`
}
The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.
When deploying to AWS Organizations accounts with `SERVICE_MANAGED` permissions:
- You must specify the `OrganizationalUnitIds` property. - If you specify organizational units (OUs) for `OrganizationalUnitIds` and use either the `Accounts` or `AccountsUrl` property, you must also specify the `AccountFilterType` property.
When deploying to AWS accounts with `SELF_MANAGED` permissions:
- You must specify either the `Accounts` or `AccountsUrl` property, but not both.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
deploymentTargetsProperty := &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
}
type CfnStackSet_ManagedExecutionProperty struct {
Active interface{} `field:"optional" json:"active" yaml:"active"`
}
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
managedExecutionProperty := &ManagedExecutionProperty{
Active: jsii.Boolean(false),
}
type CfnStackSet_OperationPreferencesProperty struct {
ConcurrencyMode *string `field:"optional" json:"concurrencyMode" yaml:"concurrencyMode"`
FailureToleranceCount *float64 `field:"optional" json:"failureToleranceCount" yaml:"failureToleranceCount"`
FailureTolerancePercentage *float64 `field:"optional" json:"failureTolerancePercentage" yaml:"failureTolerancePercentage"`
MaxConcurrentCount *float64 `field:"optional" json:"maxConcurrentCount" yaml:"maxConcurrentCount"`
MaxConcurrentPercentage *float64 `field:"optional" json:"maxConcurrentPercentage" yaml:"maxConcurrentPercentage"`
RegionConcurrencyType *string `field:"optional" json:"regionConcurrencyType" yaml:"regionConcurrencyType"`
RegionOrder *[]*string `field:"optional" json:"regionOrder" yaml:"regionOrder"`
}
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information on maximum concurrent accounts and failure tolerance, see [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
operationPreferencesProperty := &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
}
type CfnStackSet_ParameterProperty struct {
ParameterKey *string `field:"required" json:"parameterKey" yaml:"parameterKey"`
ParameterValue *string `field:"required" json:"parameterValue" yaml:"parameterValue"`
}
The Parameter data type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
parameterProperty := &ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
}
type CfnStackSet_StackInstancesProperty struct {
DeploymentTargets interface{} `field:"required" json:"deploymentTargets" yaml:"deploymentTargets"`
Regions *[]*string `field:"required" json:"regions" yaml:"regions"`
ParameterOverrides interface{} `field:"optional" json:"parameterOverrides" yaml:"parameterOverrides"`
}
Stack instances in some specific accounts and Regions.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
stackInstancesProperty := &StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
}
type CfnStack_OutputProperty struct {
Description *string `field:"optional" json:"description" yaml:"description"`
ExportName *string `field:"optional" json:"exportName" yaml:"exportName"`
OutputKey *string `field:"optional" json:"outputKey" yaml:"outputKey"`
OutputValue *string `field:"optional" json:"outputValue" yaml:"outputValue"`
}
The `Output` data type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
outputProperty := &OutputProperty{
Description: jsii.String("description"),
ExportName: jsii.String("exportName"),
OutputKey: jsii.String("outputKey"),
OutputValue: jsii.String("outputValue"),
}
type CfnTag struct {
Key *string `field:"required" json:"key" yaml:"key"`
Value *string `field:"required" json:"value" yaml:"value"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTag := &CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnTrafficRoute struct {
LogicalId *string `field:"required" json:"logicalId" yaml:"logicalId"`
Type *string `field:"required" json:"type" yaml:"type"`
}
A traffic route, representing where the traffic is being directed to.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTrafficRoute := &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
}
type CfnTrafficRouting struct {
ProdTrafficRoute *CfnTrafficRoute `field:"required" json:"prodTrafficRoute" yaml:"prodTrafficRoute"`
TargetGroups *[]*string `field:"required" json:"targetGroups" yaml:"targetGroups"`
TestTrafficRoute *CfnTrafficRoute `field:"required" json:"testTrafficRoute" yaml:"testTrafficRoute"`
}
Type of the `CfnCodeDeployBlueGreenEcsAttributes.trafficRouting` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTrafficRouting := &CfnTrafficRouting{
ProdTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
TargetGroups: []*string{
jsii.String("targetGroups"),
},
TestTrafficRoute: &CfnTrafficRoute{
LogicalId: jsii.String("logicalId"),
Type: jsii.String("type"),
},
}
type CfnTrafficRoutingConfig struct {
Type CfnTrafficRoutingType `field:"required" json:"type" yaml:"type"`
TimeBasedCanary *CfnTrafficRoutingTimeBasedCanary `field:"optional" json:"timeBasedCanary" yaml:"timeBasedCanary"`
TimeBasedLinear *CfnTrafficRoutingTimeBasedLinear `field:"optional" json:"timeBasedLinear" yaml:"timeBasedLinear"`
}
Traffic routing configuration settings.
The type of the `CfnCodeDeployBlueGreenHookProps.trafficRoutingConfig` property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTrafficRoutingConfig := &CfnTrafficRoutingConfig{
Type: cdk.CfnTrafficRoutingType_ALL_AT_ONCE,
// the properties below are optional
TimeBasedCanary: &CfnTrafficRoutingTimeBasedCanary{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
},
TimeBasedLinear: &CfnTrafficRoutingTimeBasedLinear{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
},
}
type CfnTrafficRoutingTimeBasedCanary struct {
BakeTimeMins *float64 `field:"optional" json:"bakeTimeMins" yaml:"bakeTimeMins"`
StepPercentage *float64 `field:"optional" json:"stepPercentage" yaml:"stepPercentage"`
}
The traffic routing configuration if `CfnTrafficRoutingConfig.type` is `CfnTrafficRoutingType.TIME_BASED_CANARY`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTrafficRoutingTimeBasedCanary := &CfnTrafficRoutingTimeBasedCanary{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
}
type CfnTrafficRoutingTimeBasedLinear struct {
BakeTimeMins *float64 `field:"optional" json:"bakeTimeMins" yaml:"bakeTimeMins"`
StepPercentage *float64 `field:"optional" json:"stepPercentage" yaml:"stepPercentage"`
}
The traffic routing configuration if `CfnTrafficRoutingConfig.type` is `CfnTrafficRoutingType.TIME_BASED_LINEAR`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTrafficRoutingTimeBasedLinear := &CfnTrafficRoutingTimeBasedLinear{
BakeTimeMins: jsii.Number(123),
StepPercentage: jsii.Number(123),
}
type CfnTrafficRoutingType string
The possible types of traffic shifting for the blue-green deployment configuration.
The type of the `CfnTrafficRoutingConfig.type` property.
const ( CfnTrafficRoutingType_ALL_AT_ONCE CfnTrafficRoutingType = "ALL_AT_ONCE" CfnTrafficRoutingType_TIME_BASED_CANARY CfnTrafficRoutingType = "TIME_BASED_CANARY" CfnTrafficRoutingType_TIME_BASED_LINEAR CfnTrafficRoutingType = "TIME_BASED_LINEAR" )
The `AWS::CloudFormation::TypeActivation` resource activates a public third-party extension, making it available for use in stack templates.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *CloudFormation User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTypeActivation := cdk.NewCfnTypeActivation(this, jsii.String("MyCfnTypeActivation"), &CfnTypeActivationProps{
AutoUpdate: jsii.Boolean(false),
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
MajorVersion: jsii.String("majorVersion"),
PublicTypeArn: jsii.String("publicTypeArn"),
PublisherId: jsii.String("publisherId"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
TypeNameAlias: jsii.String("typeNameAlias"),
VersionBump: jsii.String("versionBump"),
})
Create a new `AWS::CloudFormation::TypeActivation`.
type CfnTypeActivationProps struct {
AutoUpdate interface{} `field:"optional" json:"autoUpdate" yaml:"autoUpdate"`
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
MajorVersion *string `field:"optional" json:"majorVersion" yaml:"majorVersion"`
PublicTypeArn *string `field:"optional" json:"publicTypeArn" yaml:"publicTypeArn"`
PublisherId *string `field:"optional" json:"publisherId" yaml:"publisherId"`
Type *string `field:"optional" json:"type" yaml:"type"`
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
TypeNameAlias *string `field:"optional" json:"typeNameAlias" yaml:"typeNameAlias"`
VersionBump *string `field:"optional" json:"versionBump" yaml:"versionBump"`
}
Properties for defining a `CfnTypeActivation`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnTypeActivationProps := &CfnTypeActivationProps{
AutoUpdate: jsii.Boolean(false),
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
MajorVersion: jsii.String("majorVersion"),
PublicTypeArn: jsii.String("publicTypeArn"),
PublisherId: jsii.String("publisherId"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
TypeNameAlias: jsii.String("typeNameAlias"),
VersionBump: jsii.String("versionBump"),
}
type CfnTypeActivation_LoggingConfigProperty struct {
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Contains logging configuration information for an extension.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
type CfnUpdatePolicy struct {
AutoScalingReplacingUpdate *CfnAutoScalingReplacingUpdate `field:"optional" json:"autoScalingReplacingUpdate" yaml:"autoScalingReplacingUpdate"`
AutoScalingRollingUpdate *CfnAutoScalingRollingUpdate `field:"optional" json:"autoScalingRollingUpdate" yaml:"autoScalingRollingUpdate"`
AutoScalingScheduledAction *CfnAutoScalingScheduledAction `field:"optional" json:"autoScalingScheduledAction" yaml:"autoScalingScheduledAction"`
CodeDeployLambdaAliasUpdate *CfnCodeDeployLambdaAliasUpdate `field:"optional" json:"codeDeployLambdaAliasUpdate" yaml:"codeDeployLambdaAliasUpdate"`
EnableVersionUpgrade *bool `field:"optional" json:"enableVersionUpgrade" yaml:"enableVersionUpgrade"`
UseOnlineResharding *bool `field:"optional" json:"useOnlineResharding" yaml:"useOnlineResharding"`
}
Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnUpdatePolicy := &CfnUpdatePolicy{
AutoScalingReplacingUpdate: &CfnAutoScalingReplacingUpdate{
WillReplace: jsii.Boolean(false),
},
AutoScalingRollingUpdate: &CfnAutoScalingRollingUpdate{
MaxBatchSize: jsii.Number(123),
MinActiveInstancesPercent: jsii.Number(123),
MinInstancesInService: jsii.Number(123),
MinSuccessfulInstancesPercent: jsii.Number(123),
PauseTime: jsii.String("pauseTime"),
SuspendProcesses: []*string{
jsii.String("suspendProcesses"),
},
WaitOnResourceSignals: jsii.Boolean(false),
},
AutoScalingScheduledAction: &CfnAutoScalingScheduledAction{
IgnoreUnmodifiedGroupSizeProperties: jsii.Boolean(false),
},
CodeDeployLambdaAliasUpdate: &CfnCodeDeployLambdaAliasUpdate{
ApplicationName: jsii.String("applicationName"),
DeploymentGroupName: jsii.String("deploymentGroupName"),
// the properties below are optional
AfterAllowTrafficHook: jsii.String("afterAllowTrafficHook"),
BeforeAllowTrafficHook: jsii.String("beforeAllowTrafficHook"),
},
EnableVersionUpgrade: jsii.Boolean(false),
UseOnlineResharding: jsii.Boolean(false),
}
The `AWS::CloudFormation::WaitCondition` resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.
In these situations, we recommend that you associate a `CreationPolicy` attribute with the wait condition instead of using a wait condition handle. For more information and an example, see [CreationPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-creationpolicy.html) in the *CloudFormation User Guide* . If you use a `CreationPolicy` with a wait condition, don't specify any of the wait condition's properties.
> If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Access CloudFormation using an interface endpoint ( AWS PrivateLink )](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *CloudFormation User Guide* . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a `CreationPolicy` attribute to those resources, and use the `cfn-signal` helper script to signal when an instance creation process has completed successfully.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnWaitCondition := cdk.NewCfnWaitCondition(this, jsii.String("MyCfnWaitCondition"), &CfnWaitConditionProps{
Count: jsii.Number(123),
Handle: jsii.String("handle"),
Timeout: jsii.String("timeout"),
})
Create a new `AWS::CloudFormation::WaitCondition`.
type CfnWaitConditionHandle ¶
The `AWS::CloudFormation::WaitConditionHandle` type has no properties.
When you reference the `WaitConditionHandle` resource by using the `Ref` function, CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated `AWS::CloudFormation::WaitCondition` resource checks the URL for the required number of success signals or for a failure signal.
For more information, see [Create wait conditions in a CloudFormation template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) in the *CloudFormation User Guide* .
Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
Updates aren't supported for this resource.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnWaitConditionHandle := cdk.NewCfnWaitConditionHandle(this, jsii.String("MyCfnWaitConditionHandle"), &CfnWaitConditionHandleProps{
})
type CfnWaitConditionProps struct {
Count *float64 `field:"optional" json:"count" yaml:"count"`
Handle *string `field:"optional" json:"handle" yaml:"handle"`
Timeout *string `field:"optional" json:"timeout" yaml:"timeout"`
}
Properties for defining a `CfnWaitCondition`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cfnWaitConditionProps := &CfnWaitConditionProps{
Count: jsii.Number(123),
Handle: jsii.String("handle"),
Timeout: jsii.String("timeout"),
}
A synthesizer that uses conventional asset locations, but not conventional deployment roles.
Instead of assuming the bootstrapped deployment roles, all stack operations will be performed using the CLI's current credentials.
- This synthesizer does not support deploying to accounts to which the CLI does not have credentials. It also does not support deploying using **CDK Pipelines**. For either of those features, use `DefaultStackSynthesizer`.
- This synthesizer requires an S3 bucket and ECR repository with well-known names. To not depend on those, use `LegacyStackSynthesizer`.
Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.
By default, expects the environment to have been bootstrapped with just the staging resources of the Bootstrap Stack V2 (also known as "modern bootstrap stack"). You can override the default names using the synthesizer's construction properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cliCredentialsStackSynthesizer := cdk.NewCliCredentialsStackSynthesizer(&CliCredentialsStackSynthesizerProps{
BucketPrefix: jsii.String("bucketPrefix"),
DockerTagPrefix: jsii.String("dockerTagPrefix"),
FileAssetsBucketName: jsii.String("fileAssetsBucketName"),
ImageAssetsRepositoryName: jsii.String("imageAssetsRepositoryName"),
Qualifier: jsii.String("qualifier"),
})
func NewCliCredentialsStackSynthesizer(props *CliCredentialsStackSynthesizerProps) CliCredentialsStackSynthesizer
type CliCredentialsStackSynthesizerProps struct {
BucketPrefix *string `field:"optional" json:"bucketPrefix" yaml:"bucketPrefix"`
DockerTagPrefix *string `field:"optional" json:"dockerTagPrefix" yaml:"dockerTagPrefix"`
FileAssetsBucketName *string `field:"optional" json:"fileAssetsBucketName" yaml:"fileAssetsBucketName"`
ImageAssetsRepositoryName *string `field:"optional" json:"imageAssetsRepositoryName" yaml:"imageAssetsRepositoryName"`
Qualifier *string `field:"optional" json:"qualifier" yaml:"qualifier"`
}
Properties for the CliCredentialsStackSynthesizer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cliCredentialsStackSynthesizerProps := &CliCredentialsStackSynthesizerProps{
BucketPrefix: jsii.String("bucketPrefix"),
DockerTagPrefix: jsii.String("dockerTagPrefix"),
FileAssetsBucketName: jsii.String("fileAssetsBucketName"),
ImageAssetsRepositoryName: jsii.String("imageAssetsRepositoryName"),
Qualifier: jsii.String("qualifier"),
}
type ContextProvider interface {
}
Base class for the model side of context providers.
Instances of this class communicate with context provider plugins in the 'cdk toolkit' via context variables (input), outputting specialized queries for more context variables (output).
ContextProvider needs access to a Construct to hook into the context mechanism.
type CopyOptions struct {
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
Follow SymlinkFollowMode `field:"optional" json:"follow" yaml:"follow"`
IgnoreMode IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
}
Options applied when copying directories.
Example:
// 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"
copyOptions := &CopyOptions{
Exclude: []*string{
jsii.String("exclude"),
},
Follow: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}
Instantiation of a custom resource, whose implementation is provided a Provider.
This class is intended to be used by construct library authors. Application builder should not be able to tell whether or not a construct is backed by a custom resource, and so the use of this class should be invisible.
Instead, construct library authors declare a custom construct that hides the choice of provider, and accepts a strongly-typed properties object with the properties your provider accepts.
Your custom resource provider (identified by the `serviceToken` property) can be one of 4 constructs:
- If you are authoring a construct library or application, we recommend you use the `Provider` class in the `custom-resources` module.
- If you are authoring a construct for the CDK's AWS Construct Library, you should use the `CustomResourceProvider` construct in this package.
- If you want full control over the provider, you can always directly use a Lambda Function or SNS Topic by passing the ARN into `serviceToken`.
Example:
stack := awscdk.Newstack()
durToken := awscdk.NewCfnParameter(stack, jsii.String("MyParameter"), &CfnParameterProps{
Type: jsii.String("Number"),
Default: jsii.Number(60),
})
awscdk.NewCustomResource(stack, jsii.String("MyCustomResource"), &CustomResourceProps{
ServiceToken: jsii.String("MyServiceToken"),
ServiceTimeout: awscdk.Duration_Seconds(durToken.valueAsNumber),
})
type CustomResourceProps struct {
ServiceToken *string `field:"required" json:"serviceToken" yaml:"serviceToken"`
PascalCaseProperties *bool `field:"optional" json:"pascalCaseProperties" yaml:"pascalCaseProperties"`
Properties *map[string]interface{} `field:"optional" json:"properties" yaml:"properties"`
RemovalPolicy RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"`
ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
ServiceTimeout Duration `field:"optional" json:"serviceTimeout" yaml:"serviceTimeout"`
}
Properties to provide a Lambda-backed custom resource.
Example:
stack := awscdk.Newstack()
durToken := awscdk.NewCfnParameter(stack, jsii.String("MyParameter"), &CfnParameterProps{
Type: jsii.String("Number"),
Default: jsii.Number(60),
})
awscdk.NewCustomResource(stack, jsii.String("MyCustomResource"), &CustomResourceProps{
ServiceToken: jsii.String("MyServiceToken"),
ServiceTimeout: awscdk.Duration_Seconds(durToken.valueAsNumber),
})
An AWS-Lambda backed custom resource provider, for CDK Construct Library constructs.
This is a provider for `CustomResource` constructs, backed by an AWS Lambda Function. It only supports NodeJS runtimes.
> **Application builders do not need to use this provider type**. This is not > a generic custom resource provider class. It is specifically > intended to be used only by constructs in the AWS CDK Construct Library, and > only exists here because of reverse dependency issues (for example, it cannot > use `iam.PolicyStatement` objects, since the `iam` library already depends on > the CDK `core` library and we cannot have cyclic dependencies).
If you are not writing constructs for the AWS Construct Library, you should use the `Provider` class in the `custom-resources` module instead, which has a better API and supports all Lambda runtimes, not just Node.
N.B.: When you are writing Custom Resource Providers, there are a number of lifecycle events you have to pay attention to. These are documented in the README of the `custom-resources` module. Be sure to give the documentation in that module a read, regardless of whether you end up using the Provider class in there or this one.
Example:
provider := awscdk.CustomResourceProvider_GetOrCreateProvider(this, jsii.String("Custom::MyCustomResourceType"), &CustomResourceProviderProps{
CodeDirectory: fmt.Sprintf("%v/my-handler", __dirname),
Runtime: awscdk.CustomResourceProviderRuntime_NODEJS_18_X,
})
provider.AddToRolePolicy(map[string]*string{
"Effect": jsii.String("Allow"),
"Action": jsii.String("s3:GetObject"),
"Resource": jsii.String("*"),
})
Returns a stack-level singleton for the custom resource provider.
Returns: the service token of the custom resource provider, which should be used when defining a `CustomResource`.
Base class for creating a custom resource provider.
type CustomResourceProviderBaseProps struct {
Description *string `field:"optional" json:"description" yaml:"description"`
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
MemorySize Size `field:"optional" json:"memorySize" yaml:"memorySize"`
PolicyStatements *[]interface{} `field:"optional" json:"policyStatements" yaml:"policyStatements"`
Timeout Duration `field:"optional" json:"timeout" yaml:"timeout"`
UseCfnResponseWrapper *bool `field:"optional" json:"useCfnResponseWrapper" yaml:"useCfnResponseWrapper"`
CodeDirectory *string `field:"required" json:"codeDirectory" yaml:"codeDirectory"`
RuntimeName *string `field:"required" json:"runtimeName" yaml:"runtimeName"`
}
Initialization properties for `CustomResourceProviderBase`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var policyStatements interface{}
var size Size
customResourceProviderBaseProps := &CustomResourceProviderBaseProps{
CodeDirectory: jsii.String("codeDirectory"),
RuntimeName: jsii.String("runtimeName"),
// the properties below are optional
Description: jsii.String("description"),
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
MemorySize: size,
PolicyStatements: []interface{}{
policyStatements,
},
Timeout: cdk.Duration_Minutes(jsii.Number(30)),
UseCfnResponseWrapper: jsii.Boolean(false),
}
type CustomResourceProviderOptions struct {
Description *string `field:"optional" json:"description" yaml:"description"`
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
MemorySize Size `field:"optional" json:"memorySize" yaml:"memorySize"`
PolicyStatements *[]interface{} `field:"optional" json:"policyStatements" yaml:"policyStatements"`
Timeout Duration `field:"optional" json:"timeout" yaml:"timeout"`
UseCfnResponseWrapper *bool `field:"optional" json:"useCfnResponseWrapper" yaml:"useCfnResponseWrapper"`
}
Initialization options for custom resource providers.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var policyStatements interface{}
var size Size
customResourceProviderOptions := &CustomResourceProviderOptions{
Description: jsii.String("description"),
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
MemorySize: size,
PolicyStatements: []interface{}{
policyStatements,
},
Timeout: cdk.Duration_Minutes(jsii.Number(30)),
UseCfnResponseWrapper: jsii.Boolean(false),
}
type CustomResourceProviderProps struct {
Description *string `field:"optional" json:"description" yaml:"description"`
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
MemorySize Size `field:"optional" json:"memorySize" yaml:"memorySize"`
PolicyStatements *[]interface{} `field:"optional" json:"policyStatements" yaml:"policyStatements"`
Timeout Duration `field:"optional" json:"timeout" yaml:"timeout"`
UseCfnResponseWrapper *bool `field:"optional" json:"useCfnResponseWrapper" yaml:"useCfnResponseWrapper"`
CodeDirectory *string `field:"required" json:"codeDirectory" yaml:"codeDirectory"`
Runtime CustomResourceProviderRuntime `field:"required" json:"runtime" yaml:"runtime"`
}
Initialization properties for `CustomResourceProvider`.
Example:
provider := awscdk.CustomResourceProvider_GetOrCreateProvider(this, jsii.String("Custom::MyCustomResourceType"), &CustomResourceProviderProps{
CodeDirectory: fmt.Sprintf("%v/my-handler", __dirname),
Runtime: awscdk.CustomResourceProviderRuntime_NODEJS_18_X,
})
provider.AddToRolePolicy(map[string]*string{
"Effect": jsii.String("Allow"),
"Action": jsii.String("s3:GetObject"),
"Resource": jsii.String("*"),
})
type CustomResourceProviderRuntime string
The lambda runtime to use for the resource provider.
This also indicates which language is used for the handler.
Example:
provider := awscdk.CustomResourceProvider_GetOrCreateProvider(this, jsii.String("Custom::MyCustomResourceType"), &CustomResourceProviderProps{
CodeDirectory: fmt.Sprintf("%v/my-handler", __dirname),
Runtime: awscdk.CustomResourceProviderRuntime_NODEJS_18_X,
})
provider.AddToRolePolicy(map[string]*string{
"Effect": jsii.String("Allow"),
"Action": jsii.String("s3:GetObject"),
"Resource": jsii.String("*"),
})
const ( CustomResourceProviderRuntime_NODEJS_12_X CustomResourceProviderRuntime = "NODEJS_12_X" CustomResourceProviderRuntime_NODEJS_14_X CustomResourceProviderRuntime = "NODEJS_14_X" CustomResourceProviderRuntime_NODEJS_16_X CustomResourceProviderRuntime = "NODEJS_16_X" CustomResourceProviderRuntime_NODEJS_18_X CustomResourceProviderRuntime = "NODEJS_18_X" CustomResourceProviderRuntime_NODEJS_20_X CustomResourceProviderRuntime = "NODEJS_20_X" CustomResourceProviderRuntime_NODEJS_22_X CustomResourceProviderRuntime = "NODEJS_22_X" )
Uses conventionally named roles and asset storage locations.
This synthesizer:
- Supports cross-account deployments (the CLI can have credentials to one account, and you can still deploy to another account by assuming roles with well-known names in the other account).
- Supports the **CDK Pipelines** library.
Requires the environment to have been bootstrapped with Bootstrap Stack V2 (also known as "modern bootstrap stack"). The synthesizer adds a version check to the template, to make sure the bootstrap stack is recent enough to support all features expected by this synthesizer.
Example:
type myStack struct {
Stack
}
func newMyStack(scope Construct, id *string, props StackProps) *myStack {
this := &myStack{}
newStack_Override(this, scope, id, &StackProps{
(SpreadAssignment ...props
Props),
Synthesizer: awscdk.NewDefaultStackSynthesizer(&DefaultStackSynthesizerProps{
DeployRoleExternalId: jsii.String(""),
DeployRoleAdditionalOptions: map[string]interface{}{
},
FileAssetPublishingExternalId: jsii.String(""),
FileAssetPublishingRoleAdditionalOptions: map[string]interface{}{
},
ImageAssetPublishingExternalId: jsii.String(""),
ImageAssetPublishingRoleAdditionalOptions: map[string]interface{}{
},
LookupRoleExternalId: jsii.String(""),
LookupRoleAdditionalOptions: map[string]interface{}{
},
}),
})
return this
}
func NewDefaultStackSynthesizer(props *DefaultStackSynthesizerProps) DefaultStackSynthesizer
type DefaultStackSynthesizerProps struct {
BootstrapStackVersionSsmParameter *string `field:"optional" json:"bootstrapStackVersionSsmParameter" yaml:"bootstrapStackVersionSsmParameter"`
BucketPrefix *string `field:"optional" json:"bucketPrefix" yaml:"bucketPrefix"`
CloudFormationExecutionRole *string `field:"optional" json:"cloudFormationExecutionRole" yaml:"cloudFormationExecutionRole"`
DeployRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"deployRoleAdditionalOptions" yaml:"deployRoleAdditionalOptions"`
DeployRoleArn *string `field:"optional" json:"deployRoleArn" yaml:"deployRoleArn"`
DeployRoleExternalId *string `field:"optional" json:"deployRoleExternalId" yaml:"deployRoleExternalId"`
DockerTagPrefix *string `field:"optional" json:"dockerTagPrefix" yaml:"dockerTagPrefix"`
FileAssetPublishingExternalId *string `field:"optional" json:"fileAssetPublishingExternalId" yaml:"fileAssetPublishingExternalId"`
FileAssetPublishingRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"fileAssetPublishingRoleAdditionalOptions" yaml:"fileAssetPublishingRoleAdditionalOptions"`
FileAssetPublishingRoleArn *string `field:"optional" json:"fileAssetPublishingRoleArn" yaml:"fileAssetPublishingRoleArn"`
FileAssetsBucketName *string `field:"optional" json:"fileAssetsBucketName" yaml:"fileAssetsBucketName"`
GenerateBootstrapVersionRule *bool `field:"optional" json:"generateBootstrapVersionRule" yaml:"generateBootstrapVersionRule"`
ImageAssetPublishingExternalId *string `field:"optional" json:"imageAssetPublishingExternalId" yaml:"imageAssetPublishingExternalId"`
ImageAssetPublishingRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"imageAssetPublishingRoleAdditionalOptions" yaml:"imageAssetPublishingRoleAdditionalOptions"`
ImageAssetPublishingRoleArn *string `field:"optional" json:"imageAssetPublishingRoleArn" yaml:"imageAssetPublishingRoleArn"`
ImageAssetsRepositoryName *string `field:"optional" json:"imageAssetsRepositoryName" yaml:"imageAssetsRepositoryName"`
LookupRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"lookupRoleAdditionalOptions" yaml:"lookupRoleAdditionalOptions"`
LookupRoleArn *string `field:"optional" json:"lookupRoleArn" yaml:"lookupRoleArn"`
LookupRoleExternalId *string `field:"optional" json:"lookupRoleExternalId" yaml:"lookupRoleExternalId"`
Qualifier *string `field:"optional" json:"qualifier" yaml:"qualifier"`
UseLookupRoleForStackOperations *bool `field:"optional" json:"useLookupRoleForStackOperations" yaml:"useLookupRoleForStackOperations"`
}
Configuration properties for DefaultStackSynthesizer.
Example:
var app App
prodStage := awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromName(jsii.String("cdk-${Qualifier}-PermissionsBoundary-${AWS::AccountId}-${AWS::Region}")),
})
awscdk.Newstack(prodStage, jsii.String("ProdStack"), &StackProps{
Synthesizer: awscdk.NewDefaultStackSynthesizer(&DefaultStackSynthesizerProps{
Qualifier: jsii.String("custom"),
}),
})
type DefaultTokenResolver interface {
ITokenResolver
ResolveList(l *[]*string, context IResolveContext) interface{}
ResolveString(s TokenizedStringFragments, context IResolveContext) interface{}
ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}
Default resolver implementation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" var fragmentConcatenator IFragmentConcatenator defaultTokenResolver := cdk.NewDefaultTokenResolver(fragmentConcatenator)
func NewDefaultTokenResolver(concat IFragmentConcatenator) DefaultTokenResolver
type DockerBuildOptions struct {
BuildArgs *map[string]*string `field:"optional" json:"buildArgs" yaml:"buildArgs"`
CacheDisabled *bool `field:"optional" json:"cacheDisabled" yaml:"cacheDisabled"`
CacheFrom *[]*DockerCacheOption `field:"optional" json:"cacheFrom" yaml:"cacheFrom"`
CacheTo *DockerCacheOption `field:"optional" json:"cacheTo" yaml:"cacheTo"`
File *string `field:"optional" json:"file" yaml:"file"`
Network *string `field:"optional" json:"network" yaml:"network"`
Platform *string `field:"optional" json:"platform" yaml:"platform"`
TargetStage *string `field:"optional" json:"targetStage" yaml:"targetStage"`
}
Docker build options.
Example:
lambda.NewFunction(this, jsii.String("Function"), &FunctionProps{
Code: lambda.Code_FromAsset(jsii.String("/path/to/handler"), &AssetOptions{
Bundling: &BundlingOptions{
Image: awscdk.DockerImage_FromBuild(jsii.String("/path/to/dir/with/DockerFile"), &DockerBuildOptions{
BuildArgs: map[string]*string{
"ARG1": jsii.String("value1"),
},
}),
Command: []*string{
jsii.String("my"),
jsii.String("cool"),
jsii.String("command"),
},
},
}),
Runtime: lambda.Runtime_PYTHON_3_9(),
Handler: jsii.String("index.handler"),
})
type DockerBuildSecret interface {
}
Methods to build Docker CLI arguments for builds using secrets.
Docker BuildKit must be enabled to use build secrets.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" dockerBuildSecret := cdk.NewDockerBuildSecret()
See: https://docs.docker.com/build/buildkit/
func NewDockerBuildSecret() DockerBuildSecret
type DockerCacheOption struct {
Type *string `field:"required" json:"type" yaml:"type"`
Params *map[string]*string `field:"optional" json:"params" yaml:"params"`
}
Options for configuring the Docker cache backend.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerCacheOption := &DockerCacheOption{
Type: jsii.String("type"),
// the properties below are optional
Params: map[string]*string{
"paramsKey": jsii.String("params"),
},
}
type DockerIgnoreStrategy interface {
IgnoreStrategy
Add(pattern *string)
CompletelyIgnores(absoluteDirectoryPath *string) *bool
Ignores(absoluteFilePath *string) *bool
}
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerIgnoreStrategy := cdk.NewDockerIgnoreStrategy(jsii.String("absoluteRootPath"), []*string{
jsii.String("patterns"),
})
func NewDockerIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) DockerIgnoreStrategy
A Docker image.
Example:
entry := "/path/to/function"
image := awscdk.DockerImage_FromBuild(entry)
python.NewPythonFunction(this, jsii.String("function"), &PythonFunctionProps{
Entry: jsii.String(Entry),
Runtime: awscdk.Runtime_PYTHON_3_8(),
Bundling: &BundlingOptions{
BuildArgs: map[string]*string{
"PIP_INDEX_URL": jsii.String("https://your.index.url/simple/"),
"PIP_EXTRA_INDEX_URL": jsii.String("https://your.extra-index.url/simple/"),
},
},
})
func DockerImage_FromBuild(path *string, options *DockerBuildOptions) DockerImage
Builds a Docker image.
func DockerImage_FromRegistry(image *string) DockerImage
Reference an image on DockerHub or another online registry.
type DockerImageAssetLocation struct {
ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"`
RepositoryName *string `field:"required" json:"repositoryName" yaml:"repositoryName"`
ImageTag *string `field:"optional" json:"imageTag" yaml:"imageTag"`
}
The location of the published docker image.
This is where the image can be consumed at runtime.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerImageAssetLocation := &DockerImageAssetLocation{
ImageUri: jsii.String("imageUri"),
RepositoryName: jsii.String("repositoryName"),
// the properties below are optional
ImageTag: jsii.String("imageTag"),
}
type DockerImageAssetSource struct {
SourceHash *string `field:"required" json:"sourceHash" yaml:"sourceHash"`
AssetName *string `field:"optional" json:"assetName" yaml:"assetName"`
DirectoryName *string `field:"optional" json:"directoryName" yaml:"directoryName"`
DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
DockerBuildArgs *map[string]*string `field:"optional" json:"dockerBuildArgs" yaml:"dockerBuildArgs"`
DockerBuildSecrets *map[string]*string `field:"optional" json:"dockerBuildSecrets" yaml:"dockerBuildSecrets"`
DockerBuildSsh *string `field:"optional" json:"dockerBuildSsh" yaml:"dockerBuildSsh"`
DockerBuildTarget *string `field:"optional" json:"dockerBuildTarget" yaml:"dockerBuildTarget"`
DockerCacheDisabled *bool `field:"optional" json:"dockerCacheDisabled" yaml:"dockerCacheDisabled"`
DockerCacheFrom *[]*DockerCacheOption `field:"optional" json:"dockerCacheFrom" yaml:"dockerCacheFrom"`
DockerCacheTo *DockerCacheOption `field:"optional" json:"dockerCacheTo" yaml:"dockerCacheTo"`
DockerFile *string `field:"optional" json:"dockerFile" yaml:"dockerFile"`
DockerOutputs *[]*string `field:"optional" json:"dockerOutputs" yaml:"dockerOutputs"`
Executable *[]*string `field:"optional" json:"executable" yaml:"executable"`
NetworkMode *string `field:"optional" json:"networkMode" yaml:"networkMode"`
Platform *string `field:"optional" json:"platform" yaml:"platform"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerImageAssetSource := &DockerImageAssetSource{
SourceHash: jsii.String("sourceHash"),
// the properties below are optional
AssetName: jsii.String("assetName"),
DirectoryName: jsii.String("directoryName"),
DisplayName: jsii.String("displayName"),
DockerBuildArgs: map[string]*string{
"dockerBuildArgsKey": jsii.String("dockerBuildArgs"),
},
DockerBuildSecrets: map[string]*string{
"dockerBuildSecretsKey": jsii.String("dockerBuildSecrets"),
},
DockerBuildSsh: jsii.String("dockerBuildSsh"),
DockerBuildTarget: jsii.String("dockerBuildTarget"),
DockerCacheDisabled: jsii.Boolean(false),
DockerCacheFrom: []DockerCacheOption{
&DockerCacheOption{
Type: jsii.String("type"),
// the properties below are optional
Params: map[string]*string{
"paramsKey": jsii.String("params"),
},
},
},
DockerCacheTo: &DockerCacheOption{
Type: jsii.String("type"),
// the properties below are optional
Params: map[string]*string{
"paramsKey": jsii.String("params"),
},
},
DockerFile: jsii.String("dockerFile"),
DockerOutputs: []*string{
jsii.String("dockerOutputs"),
},
Executable: []*string{
jsii.String("executable"),
},
NetworkMode: jsii.String("networkMode"),
Platform: jsii.String("platform"),
}
type DockerRunOptions struct {
Command *[]*string `field:"optional" json:"command" yaml:"command"`
Entrypoint *[]*string `field:"optional" json:"entrypoint" yaml:"entrypoint"`
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
Network *string `field:"optional" json:"network" yaml:"network"`
Platform *string `field:"optional" json:"platform" yaml:"platform"`
SecurityOpt *string `field:"optional" json:"securityOpt" yaml:"securityOpt"`
User *string `field:"optional" json:"user" yaml:"user"`
Volumes *[]*DockerVolume `field:"optional" json:"volumes" yaml:"volumes"`
VolumesFrom *[]*string `field:"optional" json:"volumesFrom" yaml:"volumesFrom"`
WorkingDirectory *string `field:"optional" json:"workingDirectory" yaml:"workingDirectory"`
}
Docker run options.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerRunOptions := &DockerRunOptions{
Command: []*string{
jsii.String("command"),
},
Entrypoint: []*string{
jsii.String("entrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
Network: jsii.String("network"),
Platform: jsii.String("platform"),
SecurityOpt: jsii.String("securityOpt"),
User: jsii.String("user"),
Volumes: []DockerVolume{
&DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
},
},
VolumesFrom: []*string{
jsii.String("volumesFrom"),
},
WorkingDirectory: jsii.String("workingDirectory"),
}
type DockerVolume struct {
ContainerPath *string `field:"required" json:"containerPath" yaml:"containerPath"`
HostPath *string `field:"required" json:"hostPath" yaml:"hostPath"`
Consistency DockerVolumeConsistency `field:"optional" json:"consistency" yaml:"consistency"`
}
A Docker volume.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
dockerVolume := &DockerVolume{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
// the properties below are optional
Consistency: cdk.DockerVolumeConsistency_CONSISTENT,
}
type DockerVolumeConsistency string
Supported Docker volume consistency types.
Only valid on macOS due to the way file storage works on Mac.
const ( DockerVolumeConsistency_CONSISTENT DockerVolumeConsistency = "CONSISTENT" DockerVolumeConsistency_DELEGATED DockerVolumeConsistency = "DELEGATED" DockerVolumeConsistency_CACHED DockerVolumeConsistency = "CACHED" )
Represents a length of time.
The amount can be specified either as a literal value (e.g: `10`) which cannot be negative, or as an unresolved number token.
When the amount is passed as a token, unit conversion is not possible.
Example:
var myRole Role
cr.NewAwsCustomResource(this, jsii.String("Customized"), &AwsCustomResourceProps{
Role: myRole,
// must be assumable by the `lambda.amazonaws.com` service principal
Timeout: awscdk.Duration_Minutes(jsii.Number(10)),
// defaults to 2 minutes
MemorySize: jsii.Number(1025),
// defaults to 512 if installLatestAwsSdk is true
LogGroup: logs.NewLogGroup(this, jsii.String("AwsCustomResourceLogs"), &LogGroupProps{
Retention: logs.RetentionDays_ONE_DAY,
}),
FunctionName: jsii.String("my-custom-name"),
// defaults to a CloudFormation generated name
RemovalPolicy: awscdk.RemovalPolicy_RETAIN,
// defaults to `RemovalPolicy.DESTROY`
Policy: cr.AwsCustomResourcePolicy_FromSdkCalls(&SdkCallsPolicyOptions{
Resources: cr.AwsCustomResourcePolicy_ANY_RESOURCE(),
}),
})
Create a Duration representing an amount of days.
Returns: a new `Duration` representing `amount` Days.
Create a Duration representing an amount of hours.
Returns: a new `Duration` representing `amount` Hours.
Create a Duration representing an amount of milliseconds.
Returns: a new `Duration` representing `amount` ms.
Create a Duration representing an amount of minutes.
Returns: a new `Duration` representing `amount` Minutes.
Parse a period formatted according to the ISO 8601 standard.
Days are the largest ISO duration supported, i.e., weeks, months, and years are not supported.
Returns: the parsed `Duration`.
Example:
// This represents 1 day, 2 hours, 3 minutes, 4 seconds, and 567 milliseconds. "P1DT2H3M4.567S"
type EncodingOptions struct {
DisplayHint *string `field:"optional" json:"displayHint" yaml:"displayHint"`
}
Properties to string encodings.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
encodingOptions := &EncodingOptions{
DisplayHint: jsii.String("displayHint"),
}
type Environment struct {
Account *string `field:"optional" json:"account" yaml:"account"`
Region *string `field:"optional" json:"region" yaml:"region"`
}
The deployment environment for a stack.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import cloudwatch "github.com/aws/aws-cdk-go/awscdk"
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"), &StackProps{
Env: &Environment{
Region: jsii.String("us-west-2"),
},
})
globalTable := dynamodb.NewTableV2(stack, jsii.String("GlobalTable"), &TablePropsV2{
PartitionKey: &Attribute{
Name: jsii.String("pk"),
Type: dynamodb.AttributeType_STRING,
},
Replicas: []ReplicaTableProps{
&ReplicaTableProps{
Region: jsii.String("us-east-1"),
},
&ReplicaTableProps{
Region: jsii.String("us-east-2"),
},
},
})
// metric is only for the table in us-west-2
metric := globalTable.MetricConsumedReadCapacityUnits()
cloudwatch.NewAlarm(this, jsii.String("Alarm"), &AlarmProps{
Metric: metric,
EvaluationPeriods: jsii.Number(1),
Threshold: jsii.Number(1),
})
type Errors interface {
}
Helper to check if an error is of a certain type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" errors := cdk.NewErrors()
Represents a date of expiration.
The amount can be specified either as a Date object, timestamp, Duration or string.
Example:
// 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" expiration := cdk.Expiration_After(cdk.Duration_Minutes(jsii.Number(30)))
func Expiration_After(t Duration) Expiration
Expire once the specified duration has passed since deployment time.
Expire at the specified date.
func Expiration_AtTimestamp(t *float64) Expiration
Expire at the specified timestamp.
func Expiration_FromString(s *string) Expiration
Expire at specified date, represented as a string.
type ExportValueOptions struct {
Description *string `field:"optional" json:"description" yaml:"description"`
Name *string `field:"optional" json:"name" yaml:"name"`
}
Options for the `stack.exportValue()` method.
Example:
var stack Stack
stack.ExportValue(myBucket.BucketName, &ExportValueOptions{
Name: jsii.String("TheAwesomeBucket"),
Description: jsii.String("The name of an S3 bucket"),
})
Features that are implemented behind a flag in order to preserve backwards compatibility for existing apps.
The list of flags are available in the `aws-cdk-lib/cx-api` module.
The state of the flag for this application is stored as a CDK context variable.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" featureFlags := cdk.FeatureFlags_Of(this)
Inspect feature flags on the construct node's context.
type FileAssetLocation struct {
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
HttpUrl *string `field:"required" json:"httpUrl" yaml:"httpUrl"`
ObjectKey *string `field:"required" json:"objectKey" yaml:"objectKey"`
S3ObjectUrl *string `field:"required" json:"s3ObjectUrl" yaml:"s3ObjectUrl"`
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
S3ObjectUrlWithPlaceholders *string `field:"optional" json:"s3ObjectUrlWithPlaceholders" yaml:"s3ObjectUrlWithPlaceholders"`
}
The location of the published file asset.
This is where the asset can be consumed at runtime.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
fileAssetLocation := &FileAssetLocation{
BucketName: jsii.String("bucketName"),
HttpUrl: jsii.String("httpUrl"),
ObjectKey: jsii.String("objectKey"),
S3ObjectUrl: jsii.String("s3ObjectUrl"),
// the properties below are optional
KmsKeyArn: jsii.String("kmsKeyArn"),
S3ObjectUrlWithPlaceholders: jsii.String("s3ObjectUrlWithPlaceholders"),
}
type FileAssetPackaging string
Packaging modes for file assets.
const ( FileAssetPackaging_ZIP_DIRECTORY FileAssetPackaging = "ZIP_DIRECTORY" FileAssetPackaging_FILE FileAssetPackaging = "FILE" )
type FileAssetSource struct {
SourceHash *string `field:"required" json:"sourceHash" yaml:"sourceHash"`
DeployTime *bool `field:"optional" json:"deployTime" yaml:"deployTime"`
DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
Executable *[]*string `field:"optional" json:"executable" yaml:"executable"`
FileName *string `field:"optional" json:"fileName" yaml:"fileName"`
Packaging FileAssetPackaging `field:"optional" json:"packaging" yaml:"packaging"`
}
Represents the source for a file asset.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
fileAssetSource := &FileAssetSource{
SourceHash: jsii.String("sourceHash"),
// the properties below are optional
DeployTime: jsii.Boolean(false),
DisplayName: jsii.String("displayName"),
Executable: []*string{
jsii.String("executable"),
},
FileName: jsii.String("fileName"),
Packaging: cdk.FileAssetPackaging_ZIP_DIRECTORY,
}
type FileCopyOptions struct {
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
FollowSymlinks SymlinkFollowMode `field:"optional" json:"followSymlinks" yaml:"followSymlinks"`
IgnoreMode IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
}
Options applied when copying directories into the staging location.
Example:
// 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"
fileCopyOptions := &FileCopyOptions{
Exclude: []*string{
jsii.String("exclude"),
},
FollowSymlinks: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}
type FileFingerprintOptions struct {
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
FollowSymlinks SymlinkFollowMode `field:"optional" json:"followSymlinks" yaml:"followSymlinks"`
IgnoreMode IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
ExtraHash *string `field:"optional" json:"extraHash" yaml:"extraHash"`
}
Options related to calculating source hash.
Example:
// 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"
fileFingerprintOptions := &FileFingerprintOptions{
Exclude: []*string{
jsii.String("exclude"),
},
ExtraHash: jsii.String("extraHash"),
FollowSymlinks: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}
type FileSystem interface {
}
File system utilities.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" fileSystem := cdk.NewFileSystem()
func NewFileSystem() FileSystem
type FingerprintOptions struct {
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
Follow SymlinkFollowMode `field:"optional" json:"follow" yaml:"follow"`
IgnoreMode IgnoreMode `field:"optional" json:"ignoreMode" yaml:"ignoreMode"`
ExtraHash *string `field:"optional" json:"extraHash" yaml:"extraHash"`
}
Options related to calculating source hash.
Example:
// 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"
fingerprintOptions := &FingerprintOptions{
Exclude: []*string{
jsii.String("exclude"),
},
ExtraHash: jsii.String("extraHash"),
Follow: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}
CloudFormation intrinsic functions.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var destinationBucket Bucket
myBucketDeployment := s3deploy.NewBucketDeployment(this, jsii.String("DeployMeWithoutExtractingFilesOnDestination"), &BucketDeploymentProps{
Sources: []ISource{
s3deploy.Source_Asset(path.join(__dirname, jsii.String("my-website"))),
},
DestinationBucket: DestinationBucket,
Extract: jsii.Boolean(false),
})
cdk.NewCfnOutput(this, jsii.String("ObjectKey"), &CfnOutputProps{
Value: cdk.Fn_Select(jsii.Number(0), myBucketDeployment.objectKeys),
})
type GetContextKeyOptions struct {
Provider *string `field:"required" json:"provider" yaml:"provider"`
AdditionalCacheKey *string `field:"optional" json:"additionalCacheKey" yaml:"additionalCacheKey"`
IncludeEnvironment *bool `field:"optional" json:"includeEnvironment" yaml:"includeEnvironment"`
Props *map[string]interface{} `field:"optional" json:"props" yaml:"props"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var props interface{}
getContextKeyOptions := &GetContextKeyOptions{
Provider: jsii.String("provider"),
// the properties below are optional
AdditionalCacheKey: jsii.String("additionalCacheKey"),
IncludeEnvironment: jsii.Boolean(false),
Props: map[string]interface{}{
"propsKey": props,
},
}
type GetContextKeyResult struct {
Key *string `field:"required" json:"key" yaml:"key"`
Props *map[string]interface{} `field:"required" json:"props" yaml:"props"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var props interface{}
getContextKeyResult := &GetContextKeyResult{
Key: jsii.String("key"),
Props: map[string]interface{}{
"propsKey": props,
},
}
Returns: the context key or undefined if a key cannot be rendered (due to tokens used in any of the props).
type GetContextValueOptions struct {
Provider *string `field:"required" json:"provider" yaml:"provider"`
AdditionalCacheKey *string `field:"optional" json:"additionalCacheKey" yaml:"additionalCacheKey"`
IncludeEnvironment *bool `field:"optional" json:"includeEnvironment" yaml:"includeEnvironment"`
Props *map[string]interface{} `field:"optional" json:"props" yaml:"props"`
DummyValue interface{} `field:"required" json:"dummyValue" yaml:"dummyValue"`
IgnoreErrorOnMissingContext *bool `field:"optional" json:"ignoreErrorOnMissingContext" yaml:"ignoreErrorOnMissingContext"`
MustExist *bool `field:"optional" json:"mustExist" yaml:"mustExist"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var dummyValue interface{}
var props interface{}
getContextValueOptions := &GetContextValueOptions{
DummyValue: dummyValue,
Provider: jsii.String("provider"),
// the properties below are optional
AdditionalCacheKey: jsii.String("additionalCacheKey"),
IgnoreErrorOnMissingContext: jsii.Boolean(false),
IncludeEnvironment: jsii.Boolean(false),
MustExist: jsii.Boolean(false),
Props: map[string]interface{}{
"propsKey": props,
},
}
type GetContextValueResult struct {
Value interface{} `field:"optional" json:"value" yaml:"value"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var value interface{}
getContextValueResult := &GetContextValueResult{
Value: value,
}
type GitIgnoreStrategy interface {
IgnoreStrategy
Add(pattern *string)
CompletelyIgnores(absoluteDirectoryPath *string) *bool
Ignores(absoluteFilePath *string) *bool
}
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
gitIgnoreStrategy := cdk.NewGitIgnoreStrategy(jsii.String("absoluteRootPath"), []*string{
jsii.String("patterns"),
})
func DockerIgnoreStrategy_Git(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Returns: `GitIgnorePattern` associated with the given patterns.
func NewGitIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GitIgnoreStrategy
type GlobIgnoreStrategy interface {
IgnoreStrategy
Add(pattern *string)
CompletelyIgnores(absoluteDirectoryPath *string) *bool
Ignores(absoluteFilePath *string) *bool
}
Ignores file paths based on simple glob patterns.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
globIgnoreStrategy := cdk.NewGlobIgnoreStrategy(jsii.String("absoluteRootPath"), []*string{
jsii.String("patterns"),
})
func DockerIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
Ignores file paths based on simple glob patterns.
Returns: `GlobIgnorePattern` associated with the given patterns.
func GitIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
Ignores file paths based on simple glob patterns.
Returns: `GlobIgnorePattern` associated with the given patterns.
func GlobIgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
Ignores file paths based on simple glob patterns.
Returns: `GlobIgnorePattern` associated with the given patterns.
func IgnoreStrategy_Glob(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
Ignores file paths based on simple glob patterns.
Returns: `GlobIgnorePattern` associated with the given patterns.
func NewGlobIgnoreStrategy(absoluteRootPath *string, patterns *[]*string) GlobIgnoreStrategy
type IAnyProducer interface {
Produce(context IResolveContext) interface{}
}
Interface for lazy untyped value producers.
type IAsset interface {
AssetHash() *string
}
Common interface for all assets.
type IBoundStackSynthesizer interface {
IStackSynthesizer
}
A Stack Synthesizer, obtained from `IReusableStackSynthesizer.`.
Just a type alias with a very concrete contract.
type ICfnConditionExpression interface {
IResolvable
}
Represents a CloudFormation element that can be used within a Condition.
You can use intrinsic functions, such as “Fn.conditionIf“, “Fn.conditionEquals“, and “Fn.conditionNot“, to conditionally create stack resources. These conditions are evaluated based on input parameters that you declare when you create or update a stack. After you define all your conditions, you can associate them with resources or resource properties in the Resources and Outputs sections of a template.
You define all conditions in the Conditions section of a template except for “Fn.conditionIf“ conditions. You can use the “Fn.conditionIf“ condition in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template.
You might use conditions when you want to reuse a template that can create resources in different contexts, such as a test environment versus a production environment. In your template, you can add an EnvironmentType input parameter, which accepts either prod or test as inputs. For the production environment, you might include Amazon EC2 instances with certain capabilities; however, for the test environment, you want to use less capabilities to save costs. With conditions, you can define which resources are created and how they're configured for each environment type.
You can use `toString` when you wish to embed a condition expression in a property value that accepts a `string`. For example:
```ts
new sqs.Queue(this, 'MyQueue', {
queueName: Fn.conditionIf('Condition', 'Hello', 'World').toString()
});
```.
type ICfnResourceOptions interface {
Condition() CfnCondition
SetCondition(c CfnCondition)
CreationPolicy() *CfnCreationPolicy
SetCreationPolicy(c *CfnCreationPolicy)
DeletionPolicy() CfnDeletionPolicy
SetDeletionPolicy(d CfnDeletionPolicy)
Description() *string
SetDescription(d *string)
Metadata() *map[string]interface{}
SetMetadata(m *map[string]interface{})
UpdatePolicy() *CfnUpdatePolicy
SetUpdatePolicy(u *CfnUpdatePolicy)
UpdateReplacePolicy() CfnDeletionPolicy
SetUpdateReplacePolicy(u CfnDeletionPolicy)
Version() *string
SetVersion(v *string)
}
type ICfnRuleConditionExpression interface {
ICfnConditionExpression
Disambiguator() *bool
}
Interface to specify certain functions as Service Catalog rule-specific.
These functions can only be used in “Rules“ section of template.
func Fn_ConditionAnd ¶
func Fn_ConditionAnd(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression
Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false.
“Fn::And“ acts as an AND operator. The minimum number of conditions that you can include is 1.
Returns: an FnCondition token.
Returns true if a specified string matches at least one value in a list of strings.
Returns: an FnCondition token.
func Fn_ConditionEachMemberEquals(listOfStrings *[]*string, value *string) ICfnRuleConditionExpression
Returns true if a specified string matches all values in a list.
Returns: an FnCondition token.
func Fn_ConditionEachMemberIn(stringsToCheck *[]*string, stringsToMatch *[]*string) ICfnRuleConditionExpression
Returns true if each member in a list of strings matches at least one value in a second list of strings.
Returns: an FnCondition token.
func Fn_ConditionEquals(lhs interface{}, rhs interface{}) ICfnRuleConditionExpression
Compares if two values are equal.
Returns true if the two values are equal or false if they aren't.
Returns: an FnCondition token.
func Fn_ConditionIf(conditionId *string, valueIfTrue interface{}, valueIfFalse interface{}) ICfnRuleConditionExpression
Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false.
Currently, AWS CloudFormation supports the “Fn::If“ intrinsic function in the metadata attribute, update policy attribute, and property values in the Resources section and Outputs sections of a template. You can use the AWS::NoValue pseudo parameter as a return value to remove the corresponding property.
Returns: an FnCondition token.
func Fn_ConditionNot(condition ICfnConditionExpression) ICfnRuleConditionExpression
Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true.
“Fn::Not“ acts as a NOT operator.
Returns: an FnCondition token.
func Fn_ConditionOr(conditions ...ICfnConditionExpression) ICfnRuleConditionExpression
Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false.
“Fn::Or“ acts as an OR operator. The minimum number of conditions that you can include is 1.
Returns: an FnCondition token.
type IFragmentConcatenator interface {
Join(left interface{}, right interface{}) interface{}
}
Function used to concatenate symbols in the target document language.
Interface so it could potentially be exposed over jsii.
type IInspectable interface {
Inspect(inspector TreeInspector)
}
Interface for examining a construct and exposing metadata.
type IListProducer interface {
Produce(context IResolveContext) *[]*string
}
Interface for lazy list producers.
type ILocalBundling interface {
TryBundle(outputDir *string, options *BundlingOptions) *bool
}
Local bundling.
type INumberProducer interface {
Produce(context IResolveContext) *float64
}
Interface for lazy number producers.
type IPolicyValidationContextBeta1 interface {
TemplatePaths() *[]*string
}
Context available to the validation plugin.
type IPolicyValidationPluginBeta1 interface {
Validate(context IPolicyValidationContextBeta1) *PolicyValidationPluginReportBeta1
Name() *string
RuleIds() *[]*string
Version() *string
}
Represents a validation plugin that will be executed during synthesis.
Example:
type myPlugin struct {
name
}
func (this *myPlugin) validate(context IPolicyValidationContextBeta1) PolicyValidationPluginReportBeta1 {
// First read the templates using context.templatePaths...
// ...then perform the validation, and then compose and return the report.
// Using hard-coded values here for better clarity:
return &PolicyValidationPluginReportBeta1{
Success: jsii.Boolean(false),
Violations: []PolicyViolationBeta1{
&PolicyViolationBeta1{
RuleName: jsii.String("CKV_AWS_117"),
Description: jsii.String("Ensure that AWS Lambda function is configured inside a VPC"),
Fix: jsii.String("https://docs.bridgecrew.io/docs/ensure-that-aws-lambda-function-is-configured-inside-a-vpc-1"),
ViolatingResources: []PolicyViolatingResourceBeta1{
&PolicyViolatingResourceBeta1{
ResourceLogicalId: jsii.String("MyFunction3BAA72D1"),
TemplatePath: jsii.String("/home/johndoe/myapp/cdk.out/MyService.template.json"),
Locations: []*string{
jsii.String("Properties/VpcConfig"),
},
},
},
},
},
}
}
type IPostProcessor interface {
PostProcess(input interface{}, context IResolveContext) interface{}
}
A Token that can post-process the complete resolved value, after resolve() has recursed over it.
type IPropertyInjector interface {
Inject(originalProps interface{}, context *InjectionContext) interface{}
ConstructUniqueId() *string
}
This interface define an inject function that operates on a Construct's Property.
The Construct must have a constructUniqueId to uniquely identify itself.
type IResolvable interface {
Resolve(context IResolveContext) interface{}
ToString() *string
CreationStack() *[]*string
TypeHint() ResolutionTypeHint
}
Interface for values that can be resolvable later.
Tokens are special objects that participate in synthesis.
func Fn_GetAtt(logicalNameOfResource *string, attributeName *string) IResolvable
The “Fn::GetAtt“ intrinsic function returns the value of an attribute from a resource in the template.
Returns: an IResolvable object.
func Lazy_Any(producer IStableAnyProducer, options *LazyAnyValueOptions) IResolvable
Defer the one-time calculation of an arbitrarily typed value to synthesis time.
Use this if you want to render an object to a template whose actual value depends on some state mutation that may happen after the construct has been created.
The inner function will only be invoked one time and cannot depend on resolution context.
func Lazy_UncachedAny(producer IAnyProducer, options *LazyAnyValueOptions) IResolvable
Defer the calculation of an untyped value to synthesis time.
Use of this function is not recommended; unless you know you need it for sure, you probably don't. Use `Lazy.any()` instead.
The inner function may be invoked multiple times during synthesis. You should only use this method if the returned value depends on variables that may change during the Aspect application phase of synthesis, or if the value depends on the Stack the value is being used in. Both of these cases are rare, and only ever occur for AWS Construct Library authors.
func Token_AsAny(value interface{}) IResolvable
Return a resolvable representation of the given value.
func Tokenization_Reverse(x interface{}, options *ReverseOptions) IResolvable
Reverse any value into a Resolvable, if possible.
In case of a string, the string must not be a concatenation.
func Tokenization_ReverseCompleteString(s *string) IResolvable
Un-encode a string which is either a complete encoded token, or doesn't contain tokens at all.
It's illegal for the string to be a concatenation of an encoded token and something else.
func Tokenization_ReverseList(l *[]*string) IResolvable
Un-encode a Tokenized value from a list.
func Tokenization_ReverseNumber(n *float64) IResolvable
Un-encode a Tokenized value from a number.
type IResolveContext interface {
RegisterPostProcessor(postProcessor IPostProcessor)
Resolve(x interface{}, options *ResolveChangeContextOptions) interface{}
DocumentPath() *[]*string
Preparing() *bool
Scope() constructs.IConstruct
}
Current resolution context for tokens.
Interface for L2 Resource constructs.
type IReusableStackSynthesizer interface {
IStackSynthesizer
ReusableBind(stack Stack) IBoundStackSynthesizer
}
Interface for Stack Synthesizers that can be used for more than one stack.
Regular `IStackSynthesizer` instances can only be bound to a Stack once. `IReusableStackSynthesizer` instances.
For backwards compatibility reasons, this class inherits from `IStackSynthesizer`, but if an object implements `IReusableStackSynthesizer`, no other methods than `reusableBind()` will be called.
type IStableAnyProducer interface {
Produce() interface{}
}
Interface for (stable) lazy untyped value producers.
type IStableListProducer interface {
Produce() *[]*string
}
Interface for (stable) lazy list producers.
type IStableNumberProducer interface {
Produce() *float64
}
Interface for (stable) lazy number producers.
type IStableStringProducer interface {
Produce() *string
}
Interface for (stable) lazy string producers.
type IStackSynthesizer interface {
AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation
AddFileAsset(asset *FileAssetSource) *FileAssetLocation
Bind(stack Stack)
Synthesize(session ISynthesisSession)
BootstrapQualifier() *string
LookupRole() *string
}
Encodes information how a certain Stack should be deployed.
type IStringProducer interface {
Produce(context IResolveContext) *string
}
Interface for lazy string producers.
Represents a single session of synthesis.
Passed into `Construct.synthesize()` methods.
type ITaggable interface {
Tags() TagManager
}
Interface to implement tags.
type ITaggableV2 interface {
CdkTagManager() TagManager
}
Modernized version of ITaggable.
`ITaggable` has a problem: for a number of L1 resources, we failed to generate `tags: TagManager`, and generated `tags: CfnSomeResource.TagProperty[]` instead.
To mark these resources as taggable, we need to put the `TagManager` in a new property whose name is unlikely to conflict with any existing properties. Hence, a new interface for that purpose. All future resources will implement `ITaggableV2`.
type ITemplateOptions interface {
Description() *string
SetDescription(d *string)
Metadata() *map[string]interface{}
SetMetadata(m *map[string]interface{})
TemplateFormatVersion() *string
SetTemplateFormatVersion(t *string)
Transforms() *[]*string
SetTransforms(t *[]*string)
}
CloudFormation template options for a stack.
type ITokenMapper interface {
MapToken(t IResolvable) interface{}
}
Interface to apply operation to tokens in a string.
Interface so it can be exported via jsii.
type ITokenResolver interface {
ResolveList(l *[]*string, context IResolveContext) interface{}
ResolveString(s TokenizedStringFragments, context IResolveContext) interface{}
ResolveToken(t IResolvable, context IResolveContext, postProcessor IPostProcessor) interface{}
}
How to resolve tokens.
Determines the ignore behavior to use.
Example:
lambda.NewFunction(this, jsii.String("Function"), &FunctionProps{
Code: lambda.Code_FromAsset(path.join(__dirname, jsii.String("my-python-handler")), &AssetOptions{
Exclude: []*string{
jsii.String("*.ignore"),
},
IgnoreMode: awscdk.IgnoreMode_DOCKER,
}),
Runtime: lambda.Runtime_PYTHON_3_9(),
Handler: jsii.String("index.handler"),
})
const ( IgnoreMode_GLOB IgnoreMode = "GLOB" IgnoreMode_GIT IgnoreMode = "GIT" IgnoreMode_DOCKER IgnoreMode = "DOCKER" )
type IgnoreStrategy interface {
Add(pattern *string)
CompletelyIgnores(absoluteDirectoryPath *string) *bool
Ignores(absoluteFilePath *string) *bool
}
Represents file path ignoring behavior.
Example:
// 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"
ignoreStrategy := cdk.IgnoreStrategy_FromCopyOptions(&CopyOptions{
Exclude: []*string{
jsii.String("exclude"),
},
Follow: cdk.SymlinkFollowMode_NEVER,
IgnoreMode: cdk.IgnoreMode_GLOB,
}, jsii.String("absoluteRootPath"))
func DockerIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Returns: `IgnoreStrategy` based on the `CopyOptions`.
func GitIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Returns: `IgnoreStrategy` based on the `CopyOptions`.
func GlobIgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Returns: `IgnoreStrategy` based on the `CopyOptions`.
func IgnoreStrategy_FromCopyOptions(options *CopyOptions, absoluteRootPath *string) IgnoreStrategy
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Returns: `IgnoreStrategy` based on the `CopyOptions`.
type InjectionContext struct {
Id *string `field:"required" json:"id" yaml:"id"`
Scope constructs.Construct `field:"required" json:"scope" yaml:"scope"`
}
This defines the values needed for Injection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"
var construct Construct
injectionContext := &InjectionContext{
Id: jsii.String("id"),
Scope: construct,
}
type Intrinsic interface {
IResolvable
CreationStack() *[]*string
TypeHint() ResolutionTypeHint
NewError(message *string) interface{}
Resolve(context IResolveContext) interface{}
ToJSON() interface{}
ToString() *string
ToStringList() *[]*string
}
Token subclass that represents values intrinsic to the target document language.
WARNING: this class should not be externally exposed, but is currently visible because of a limitation of jsii (https://github.com/aws/jsii/issues/524).
This class will disappear in a future release and should not be used.
Example:
// 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"
var value interface{}
intrinsic := cdk.NewIntrinsic(value, &IntrinsicProps{
StackTrace: jsii.Boolean(false),
TypeHint: cdk.ResolutionTypeHint_STRING,
})
func NewIntrinsic(value interface{}, options *IntrinsicProps) Intrinsic
type IntrinsicProps struct {
StackTrace *bool `field:"optional" json:"stackTrace" yaml:"stackTrace"`
TypeHint ResolutionTypeHint `field:"optional" json:"typeHint" yaml:"typeHint"`
}
Customization properties for an Intrinsic token.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
intrinsicProps := &IntrinsicProps{
StackTrace: jsii.Boolean(false),
TypeHint: cdk.ResolutionTypeHint_STRING,
}
type JsonNull interface {
IResolvable
CreationStack() *[]*string
Resolve(context IResolveContext) interface{}
ToJSON() interface{}
ToString() *string
}
An object which serializes to the JSON `null` literal, and which can safely be passed across languages where `undefined` and `null` are not different.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" jsonNull := cdk.JsonNull_INSTANCE()
func JsonNull_INSTANCE() JsonNull
Lazily produce a value.
Can be used to return a string, list or numeric value whose actual value will only be calculated later, during synthesis.
type LazyAnyValueOptions struct {
DisplayHint *string `field:"optional" json:"displayHint" yaml:"displayHint"`
OmitEmptyArray *bool `field:"optional" json:"omitEmptyArray" yaml:"omitEmptyArray"`
}
Options for creating lazy untyped tokens.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
lazyAnyValueOptions := &LazyAnyValueOptions{
DisplayHint: jsii.String("displayHint"),
OmitEmptyArray: jsii.Boolean(false),
}
type LazyListValueOptions struct {
DisplayHint *string `field:"optional" json:"displayHint" yaml:"displayHint"`
OmitEmpty *bool `field:"optional" json:"omitEmpty" yaml:"omitEmpty"`
}
Options for creating a lazy list token.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
lazyListValueOptions := &LazyListValueOptions{
DisplayHint: jsii.String("displayHint"),
OmitEmpty: jsii.Boolean(false),
}
type LazyStringValueOptions struct {
DisplayHint *string `field:"optional" json:"displayHint" yaml:"displayHint"`
}
Options for creating a lazy string token.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
lazyStringValueOptions := &LazyStringValueOptions{
DisplayHint: jsii.String("displayHint"),
}
Use the CDK classic way of referencing assets.
This synthesizer will generate CloudFormation parameters for every referenced asset, and use the CLI's current credentials to deploy the stack.
- It does not support cross-account deployment (the CLI must have credentials to the account you are trying to deploy to).
- It cannot be used with **CDK Pipelines**. To deploy using CDK Pipelines, you must use the `DefaultStackSynthesizer`.
- Each asset will take up a CloudFormation Parameter in your template. Keep in mind that there is a maximum of 200 parameters in a CloudFormation template. To use deterministic asset locations instead, use `CliCredentialsStackSynthesizer`.
Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.
This is the only StackSynthesizer that supports customizing asset behavior by overriding `Stack.addFileAsset()` and `Stack.addDockerImageAsset()`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" legacyStackSynthesizer := cdk.NewLegacyStackSynthesizer()
func NewLegacyStackSynthesizer() LegacyStackSynthesizer
type MissingRemovalPolicies interface {
Apply(policy RemovalPolicy, props *RemovalPolicyProps)
Destroy(props *RemovalPolicyProps)
Retain(props *RemovalPolicyProps)
RetainOnUpdateOrDelete(props *RemovalPolicyProps)
Snapshot(props *RemovalPolicyProps)
}
Manages removal policies for resources without existing policies within a construct scope.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" missingRemovalPolicies := cdk.MissingRemovalPolicies_Of(this)
Returns the missing removal policies API for the given scope.
Functions for devising unique names for constructs.
For example, those can be used to allocate unique physical names for resources.
type NestedStack interface {
Stack
Account() *string
ArtifactId() *string
AvailabilityZones() *[]*string
BundlingRequired() *bool
Dependencies() *[]Stack
Env() *interfaces.ResourceEnvironment
Environment() *string
Nested() *bool
NestedStackParent() Stack
NestedStackResource() CfnResource
Node() constructs.Node
NotificationArns() *[]*string
Partition() *string
Region() *string
StackId() *string
StackName() *string
Synthesizer() IStackSynthesizer
Tags() TagManager
TemplateFile() *string
TemplateOptions() ITemplateOptions
TerminationProtection() *bool
SetTerminationProtection(val *bool)
UrlSuffix() *string
AddDependency(target Stack, reason *string)
AddMetadata(key *string, value interface{})
AddStackTag(tagName *string, tagValue *string)
AddTransform(transform *string)
AllocateLogicalId(cfnElement CfnElement) *string
ExportStringListValue(exportedValue interface{}, options *ExportValueOptions) *[]*string
ExportValue(exportedValue interface{}, options *ExportValueOptions) *string
FormatArn(components *ArnComponents) *string
GetLogicalId(element CfnElement) *string
RegionalFact(factName *string, defaultValue *string) *string
RemoveStackTag(tagName *string)
RenameLogicalId(oldId *string, newId *string)
ReportMissingContextKey(report *cloudassemblyschema.MissingContext)
Resolve(obj interface{}) interface{}
SetParameter(name *string, value *string)
SplitArn(arn *string, arnFormat ArnFormat) *ArnComponents
ToJsonString(obj interface{}, space *float64) *string
ToString() *string
ToYamlString(obj interface{}) *string
With(mixins ...constructs.IMixin) constructs.IConstruct
}
A CloudFormation nested stack.
When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks.
Furthermore, this stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.
Cross references of resource attributes between the parent stack and the nested stack will automatically be translated to stack parameters and outputs.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
awscdk.CustomResourceConfig_Of(app).AddLogRetentionLifetime(logs.RetentionDays_TEN_YEARS)
nestedStackA := cdk.NewNestedStack(stack, jsii.String("NestedStackA"))
websiteBucketA := s3.NewBucket(nestedStackA, jsii.String("WebsiteBucketA"), &BucketProps{
})
s3deploy.NewBucketDeployment(nestedStackA, jsii.String("s3deployA"), &BucketDeploymentProps{
Sources: []ISource{
s3deploy.Source_JsonData(jsii.String("file.json"), map[string]*string{
"a": jsii.String("b"),
}),
},
DestinationBucket: websiteBucketA,
LogRetention: logs.RetentionDays_ONE_DAY,
})
nestedStackB := cdk.NewNestedStack(stack, jsii.String("NestedStackB"))
websiteBucketB := s3.NewBucket(nestedStackB, jsii.String("WebsiteBucketB"), &BucketProps{
})
s3deploy.NewBucketDeployment(nestedStackB, jsii.String("s3deployB"), &BucketDeploymentProps{
Sources: []ISource{
s3deploy.Source_*JsonData(jsii.String("file.json"), map[string]*string{
"a": jsii.String("b"),
}),
},
DestinationBucket: websiteBucketB,
LogRetention: logs.RetentionDays_ONE_DAY,
})
type NestedStackProps struct {
Description *string `field:"optional" json:"description" yaml:"description"`
NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"`
Parameters *map[string]*string `field:"optional" json:"parameters" yaml:"parameters"`
RemovalPolicy RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"`
SuppressTemplateIndentation *bool `field:"optional" json:"suppressTemplateIndentation" yaml:"suppressTemplateIndentation"`
Timeout Duration `field:"optional" json:"timeout" yaml:"timeout"`
}
Initialization props for the `NestedStack` construct.
Example:
import "github.com/aws/constructs-go/constructs"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
/**
* This file showcases how to split up a RestApi's Resources and Methods across nested stacks.
*
* The root stack 'RootStack' first defines a RestApi.
* Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.
* They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.
*
* To verify this worked, go to the APIGateway
*/
type rootStack struct {
Stack
}
func newRootStack(scope Construct) *rootStack {
this := &rootStack{}
newStack_Override(this, scope, jsii.String("integ-restapi-import-RootStack"))
restApi := awscdk.NewRestApi(this, jsii.String("RestApi"), &RestApiProps{
CloudWatchRole: jsii.Boolean(true),
Deploy: jsii.Boolean(false),
})
restApi.Root.AddMethod(jsii.String("ANY"))
petsStack := NewPetsStack(this, &resourceNestedStackProps{
restApiId: restApi.RestApiId,
rootResourceId: restApi.RestApiRootResourceId,
})
booksStack := NewBooksStack(this, &resourceNestedStackProps{
restApiId: restApi.*RestApiId,
rootResourceId: restApi.*RestApiRootResourceId,
})
NewDeployStack(this, &deployStackProps{
restApiId: restApi.*RestApiId,
methods: petsStack.methods.concat(booksStack.methods),
})
awscdk.NewCfnOutput(this, jsii.String("PetsURL"), &CfnOutputProps{
Value: fmt.Sprintf("https://%v.execute-api.%v.amazonaws.com/prod/pets", restApi.*RestApiId, this.Region),
})
awscdk.NewCfnOutput(this, jsii.String("BooksURL"), &CfnOutputProps{
Value: fmt.Sprintf("https://%v.execute-api.%v.amazonaws.com/prod/books", restApi.*RestApiId, this.*Region),
})
return this
}
type resourceNestedStackProps struct {
NestedStackProps
restApiId *string
rootResourceId *string
}
type petsStack struct {
NestedStack
methods []Method
}
func newPetsStack(scope Construct, props resourceNestedStackProps) *petsStack {
this := &petsStack{}
newNestedStack_Override(this, scope, jsii.String("integ-restapi-import-PetsStack"), props)
api := awscdk.RestApi_FromRestApiAttributes(this, jsii.String("RestApi"), &RestApiAttributes{
RestApiId: props.restApiId,
RootResourceId: props.rootResourceId,
})
method := api.Root.AddResource(jsii.String("pets")).AddMethod(jsii.String("GET"), awscdk.NewMockIntegration(&IntegrationOptions{
IntegrationResponses: []IntegrationResponse{
&IntegrationResponse{
StatusCode: jsii.String("200"),
},
},
PassthroughBehavior: awscdk.PassthroughBehavior_NEVER,
RequestTemplates: map[string]*string{
"application/json": jsii.String("{ \"statusCode\": 200 }"),
},
}), &MethodOptions{
MethodResponses: []MethodResponse{
&MethodResponse{
StatusCode: jsii.String("200"),
},
},
})
this.methods.push(method)
return this
}
type booksStack struct {
NestedStack
methods []Method
}
func newBooksStack(scope Construct, props resourceNestedStackProps) *booksStack {
this := &booksStack{}
newNestedStack_Override(this, scope, jsii.String("integ-restapi-import-BooksStack"), props)
api := awscdk.RestApi_FromRestApiAttributes(this, jsii.String("RestApi"), &RestApiAttributes{
RestApiId: props.restApiId,
RootResourceId: props.rootResourceId,
})
method := api.Root.AddResource(jsii.String("books")).AddMethod(jsii.String("GET"), awscdk.NewMockIntegration(&IntegrationOptions{
IntegrationResponses: []IntegrationResponse{
&IntegrationResponse{
StatusCode: jsii.String("200"),
},
},
PassthroughBehavior: awscdk.PassthroughBehavior_NEVER,
RequestTemplates: map[string]*string{
"application/json": jsii.String("{ \"statusCode\": 200 }"),
},
}), &MethodOptions{
MethodResponses: []MethodResponse{
&MethodResponse{
StatusCode: jsii.String("200"),
},
},
})
this.methods.push(method)
return this
}
type deployStackProps struct {
NestedStackProps
restApiId *string
methods []Method
}
type deployStack struct {
NestedStack
}
func newDeployStack(scope Construct, props deployStackProps) *deployStack {
this := &deployStack{}
newNestedStack_Override(this, scope, jsii.String("integ-restapi-import-DeployStack"), props)
deployment := awscdk.NewDeployment(this, jsii.String("Deployment"), &DeploymentProps{
Api: awscdk.RestApi_FromRestApiId(this, jsii.String("RestApi"), props.restApiId),
})
if *props.methods {
for _, method := range *props.methods {
deployment.Node.AddDependency(method)
}
}
awscdk.NewStage(this, jsii.String("Stage"), &StageProps{
Deployment: Deployment,
})
return this
}
NewRootStack(awscdk.NewApp())
Synthesizer for a nested stack.
Forwards all calls to the parent stack's synthesizer.
This synthesizer is automatically used for `NestedStack` constructs. App builder do not need to use this class directly.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" var stackSynthesizer StackSynthesizer nestedStackSynthesizer := cdk.NewNestedStackSynthesizer(stackSynthesizer)
func NewNestedStackSynthesizer(parentDeployment IStackSynthesizer) NestedStackSynthesizer
type PermissionsBoundary interface {
}
Apply a permissions boundary to all IAM Roles and Users within a specific scope.
A permissions boundary is typically applied at the `Stage` scope. This allows setting different permissions boundaries per Stage. For example, you may _not_ apply a boundary to the `Dev` stage which deploys to a personal dev account, but you _do_ apply the default boundary to the `Prod` stage.
It is possible to apply different permissions boundaries to different scopes within your app. In this case the most specifically applied one wins
Example:
// no permissions boundary for dev stage
// no permissions boundary for dev stage
awscdk.NewStage(app, jsii.String("DevStage"))
// default boundary for prod stage
prodStage := awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromName(jsii.String("prod-pb")),
})
// overriding the pb applied for this stack
// overriding the pb applied for this stack
awscdk.Newstack(prodStage, jsii.String("ProdStack1"), &StackProps{
PermissionsBoundary: awscdk.PermissionsBoundary_*FromName(jsii.String("stack-pb")),
})
// will inherit the permissions boundary from the stage
// will inherit the permissions boundary from the stage
awscdk.Newstack(prodStage, jsii.String("ProdStack2"))
func PermissionsBoundary_FromArn(arn *string) PermissionsBoundary
Apply a permissions boundary with the given ARN to all IAM Roles and Users created within a scope.
The arn can include placeholders for the partition, region, qualifier, and account These placeholders will be replaced with the actual values if available. This requires that the Stack has the environment specified, it does not work with environment agnostic stacks.
- '${AWS::Partition}' - '${AWS::Region}' - '${AWS::AccountId}' - '${Qualifier}'.
Example:
awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromArn(jsii.String("arn:aws:iam::${AWS::AccountId}:policy/my-custom-permissions-boundary")),
})
func PermissionsBoundary_FromName(name *string) PermissionsBoundary
Apply a permissions boundary with the given name to all IAM Roles and Users created within a scope.
The name can include placeholders for the partition, region, qualifier, and account These placeholders will be replaced with the actual values if available. This requires that the Stack has the environment specified, it does not work with environment agnostic stacks.
- '${AWS::Partition}' - '${AWS::Region}' - '${AWS::AccountId}' - '${Qualifier}'.
Example:
awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromName(jsii.String("my-custom-permissions-boundary")),
})
type PermissionsBoundaryBindOptions struct {
}
Options for binding a Permissions Boundary to a construct scope.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
permissionsBoundaryBindOptions := &PermissionsBoundaryBindOptions{
}
type PhysicalName interface {
}
Includes special markers for automatic generation of physical names.
type PolicyValidationPluginReportBeta1 struct {
Success *bool `field:"required" json:"success" yaml:"success"`
Violations *[]*PolicyViolationBeta1 `field:"required" json:"violations" yaml:"violations"`
Metadata *map[string]*string `field:"optional" json:"metadata" yaml:"metadata"`
PluginVersion *string `field:"optional" json:"pluginVersion" yaml:"pluginVersion"`
}
The report emitted by the plugin after evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
policyValidationPluginReportBeta1 := &PolicyValidationPluginReportBeta1{
Success: jsii.Boolean(false),
Violations: []PolicyViolationBeta1{
&PolicyViolationBeta1{
Description: jsii.String("description"),
RuleName: jsii.String("ruleName"),
ViolatingResources: []PolicyViolatingResourceBeta1{
&PolicyViolatingResourceBeta1{
Locations: []*string{
jsii.String("locations"),
},
ResourceLogicalId: jsii.String("resourceLogicalId"),
TemplatePath: jsii.String("templatePath"),
},
},
// the properties below are optional
Fix: jsii.String("fix"),
RuleMetadata: map[string]*string{
"ruleMetadataKey": jsii.String("ruleMetadata"),
},
Severity: jsii.String("severity"),
},
},
// the properties below are optional
Metadata: map[string]*string{
"metadataKey": jsii.String("metadata"),
},
PluginVersion: jsii.String("pluginVersion"),
}
type PolicyValidationReportStatusBeta1 string
The final status of the validation report.
const ( PolicyValidationReportStatusBeta1_SUCCESS PolicyValidationReportStatusBeta1 = "SUCCESS" PolicyValidationReportStatusBeta1_FAILURE PolicyValidationReportStatusBeta1 = "FAILURE" )
type PolicyViolatingResourceBeta1 struct {
Locations *[]*string `field:"required" json:"locations" yaml:"locations"`
ResourceLogicalId *string `field:"required" json:"resourceLogicalId" yaml:"resourceLogicalId"`
TemplatePath *string `field:"required" json:"templatePath" yaml:"templatePath"`
}
Resource violating a specific rule.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
policyViolatingResourceBeta1 := &PolicyViolatingResourceBeta1{
Locations: []*string{
jsii.String("locations"),
},
ResourceLogicalId: jsii.String("resourceLogicalId"),
TemplatePath: jsii.String("templatePath"),
}
type PolicyViolationBeta1 struct {
Description *string `field:"required" json:"description" yaml:"description"`
RuleName *string `field:"required" json:"ruleName" yaml:"ruleName"`
ViolatingResources *[]*PolicyViolatingResourceBeta1 `field:"required" json:"violatingResources" yaml:"violatingResources"`
Fix *string `field:"optional" json:"fix" yaml:"fix"`
RuleMetadata *map[string]*string `field:"optional" json:"ruleMetadata" yaml:"ruleMetadata"`
Severity *string `field:"optional" json:"severity" yaml:"severity"`
}
Violation produced by the validation plugin.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
policyViolationBeta1 := &PolicyViolationBeta1{
Description: jsii.String("description"),
RuleName: jsii.String("ruleName"),
ViolatingResources: []PolicyViolatingResourceBeta1{
&PolicyViolatingResourceBeta1{
Locations: []*string{
jsii.String("locations"),
},
ResourceLogicalId: jsii.String("resourceLogicalId"),
TemplatePath: jsii.String("templatePath"),
},
},
// the properties below are optional
Fix: jsii.String("fix"),
RuleMetadata: map[string]*string{
"ruleMetadataKey": jsii.String("ruleMetadata"),
},
Severity: jsii.String("severity"),
}
This is a collection of ProjectInjectors assigned to this scope.
It is keyed by constructUniqueId. There can be only one ProjectInjector for a constructUniqueId.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" propertyInjectors := cdk.PropertyInjectors_Of(this)
Returns the `PropertyInjectors` object associated with a construct scope.
If `PropertyInjectors` object doesn't exist on this scope, then it creates one and attaches it to scope.
An intrinsic Token that represents a reference to a construct.
References are recorded.
type RemovalPolicies interface {
Apply(policy RemovalPolicy, props *RemovalPolicyProps)
Destroy(props *RemovalPolicyProps)
Retain(props *RemovalPolicyProps)
RetainOnUpdateOrDelete(props *RemovalPolicyProps)
Snapshot(props *RemovalPolicyProps)
}
Manages removal policies for all resources within a construct scope, overriding any existing policies by default.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" var cluster Cluster cdk.RemovalPolicies_Of(cluster.openIdConnectProvider).Apply(cdk.RemovalPolicy_RETAIN)
Returns the removal policies API for the given scope.
Possible values for a resource's Removal Policy.
The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:
- The resource is removed from the template, so CloudFormation stops managing it;
- A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
- The stack is deleted, so CloudFormation stops managing all resources in it.
The Removal Policy applies to all above cases.
Many stateful resources in the AWS Construct Library will accept a `removalPolicy` as a property, typically defaulting it to `RETAIN`.
If the AWS Construct Library resource does not accept a `removalPolicy` argument, you can always configure it by using the escape hatch mechanism, as shown in the following example:
```ts declare const bucket: s3.Bucket;
const cfnBucket = bucket.node.findChild('Resource') as CfnResource; cfnBucket.applyRemovalPolicy(RemovalPolicy.DESTROY); ```.
Example:
var myRole Role
cr.NewAwsCustomResource(this, jsii.String("Customized"), &AwsCustomResourceProps{
Role: myRole,
// must be assumable by the `lambda.amazonaws.com` service principal
Timeout: awscdk.Duration_Minutes(jsii.Number(10)),
// defaults to 2 minutes
MemorySize: jsii.Number(1025),
// defaults to 512 if installLatestAwsSdk is true
LogGroup: logs.NewLogGroup(this, jsii.String("AwsCustomResourceLogs"), &LogGroupProps{
Retention: logs.RetentionDays_ONE_DAY,
}),
FunctionName: jsii.String("my-custom-name"),
// defaults to a CloudFormation generated name
RemovalPolicy: awscdk.RemovalPolicy_RETAIN,
// defaults to `RemovalPolicy.DESTROY`
Policy: cr.AwsCustomResourcePolicy_FromSdkCalls(&SdkCallsPolicyOptions{
Resources: cr.AwsCustomResourcePolicy_ANY_RESOURCE(),
}),
})
const ( RemovalPolicy_DESTROY RemovalPolicy = "DESTROY" RemovalPolicy_RETAIN RemovalPolicy = "RETAIN" RemovalPolicy_SNAPSHOT RemovalPolicy = "SNAPSHOT" RemovalPolicy_RETAIN_ON_UPDATE_OR_DELETE RemovalPolicy = "RETAIN_ON_UPDATE_OR_DELETE" )
type RemovalPolicyOptions struct {
ApplyToUpdateReplacePolicy *bool `field:"optional" json:"applyToUpdateReplacePolicy" yaml:"applyToUpdateReplacePolicy"`
Default RemovalPolicy `field:"optional" json:"default" yaml:"default"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
removalPolicyOptions := &RemovalPolicyOptions{
ApplyToUpdateReplacePolicy: jsii.Boolean(false),
Default: cdk.RemovalPolicy_DESTROY,
}
type RemovalPolicyProps struct {
ApplyToResourceTypes *[]*string `field:"optional" json:"applyToResourceTypes" yaml:"applyToResourceTypes"`
ExcludeResourceTypes *[]*string `field:"optional" json:"excludeResourceTypes" yaml:"excludeResourceTypes"`
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
}
Properties for applying a removal policy.
Example:
var scope Construct
var parent Construct
var bucket CfnBucket
// Apply DESTROY policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Destroy()
// Apply RETAIN policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Retain()
// Apply SNAPSHOT policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Snapshot()
// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).RetainOnUpdateOrDelete()
// Apply RETAIN policy only to specific resource types
awscdk.RemovalPolicies_Of(parent).Retain(&RemovalPolicyProps{
ApplyToResourceTypes: []*string{
jsii.String("AWS::DynamoDB::Table"),
bucket.CfnResourceType,
rds.CfnDBInstance_CFN_RESOURCE_TYPE_NAME(),
},
})
// Apply SNAPSHOT policy excluding specific resource types
awscdk.RemovalPolicies_Of(*scope).Snapshot(&RemovalPolicyProps{
ExcludeResourceTypes: []*string{
jsii.String("AWS::Test::Resource"),
},
})
The RemoveTag Aspect will handle removing tags from this node and children.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
removeTag := cdk.NewRemoveTag(jsii.String("key"), &TagProps{
ApplyToLaunchedInstances: jsii.Boolean(false),
ExcludeResourceTypes: []*string{
jsii.String("excludeResourceTypes"),
},
IncludeResourceTypes: []*string{
jsii.String("includeResourceTypes"),
},
Priority: jsii.Number(123),
})
type ResolutionTypeHint string
Type hints for resolved values.
const ( ResolutionTypeHint_STRING ResolutionTypeHint = "STRING" ResolutionTypeHint_NUMBER ResolutionTypeHint = "NUMBER" ResolutionTypeHint_STRING_LIST ResolutionTypeHint = "STRING_LIST" )
type ResolveChangeContextOptions struct {
AllowIntrinsicKeys *bool `field:"optional" json:"allowIntrinsicKeys" yaml:"allowIntrinsicKeys"`
RemoveEmpty *bool `field:"optional" json:"removeEmpty" yaml:"removeEmpty"`
}
Options that can be changed while doing a recursive resolve.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
resolveChangeContextOptions := &ResolveChangeContextOptions{
AllowIntrinsicKeys: jsii.Boolean(false),
RemoveEmpty: jsii.Boolean(false),
}
type ResolveOptions struct {
Resolver ITokenResolver `field:"required" json:"resolver" yaml:"resolver"`
Scope constructs.IConstruct `field:"required" json:"scope" yaml:"scope"`
Preparing *bool `field:"optional" json:"preparing" yaml:"preparing"`
RemoveEmpty *bool `field:"optional" json:"removeEmpty" yaml:"removeEmpty"`
}
Options to the resolve() operation.
NOT the same as the ResolveContext; ResolveContext is exposed to Token implementors and resolution hooks, whereas this struct is just to bundle a number of things that would otherwise be arguments to resolve() in a readable way.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"
var construct Construct
var tokenResolver ITokenResolver
resolveOptions := &ResolveOptions{
Resolver: tokenResolver,
Scope: construct,
// the properties below are optional
Preparing: jsii.Boolean(false),
RemoveEmpty: jsii.Boolean(false),
}
An L2 construct which represents an AWS resource.
Example:
type myConstruct struct {
Resource
tags
}
func newMyConstruct(scope Construct, id *string) *myConstruct {
this := &myConstruct{}
newResource_Override(this, scope, id)
awscdk.NewCfnResource(this, jsii.String("Resource"), &CfnResourceProps{
Type: jsii.String("Whatever::The::Type"),
Properties: map[string]interface{}{
// ...
"Tags": this.tags.renderedTags,
},
})
return this
}
type ResourceProps struct {
Account *string `field:"optional" json:"account" yaml:"account"`
EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
Region *string `field:"optional" json:"region" yaml:"region"`
}
Construction properties for `Resource`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
resourceProps := &ResourceProps{
Account: jsii.String("account"),
EnvironmentFromArn: jsii.String("environmentFromArn"),
PhysicalName: jsii.String("physicalName"),
Region: jsii.String("region"),
}
type ReverseOptions struct {
FailConcat *bool `field:"optional" json:"failConcat" yaml:"failConcat"`
}
Options for the 'reverse()' operation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
reverseOptions := &ReverseOptions{
FailConcat: jsii.Boolean(false),
}
type RoleOptions struct {
AssumeRoleArn *string `field:"required" json:"assumeRoleArn" yaml:"assumeRoleArn"`
AssumeRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"assumeRoleAdditionalOptions" yaml:"assumeRoleAdditionalOptions"`
AssumeRoleExternalId *string `field:"optional" json:"assumeRoleExternalId" yaml:"assumeRoleExternalId"`
}
Options for specifying a role.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
roleOptions := &RoleOptions{
AssumeRoleArn: jsii.String("assumeRoleArn"),
// the properties below are optional
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
}
Accessor for scoped pseudo parameters.
These pseudo parameters are anchored to a stack somewhere in the construct tree, and their values will be exported automatically.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" scopedAws := cdk.NewScopedAws(this)
type SecretValue interface {
Intrinsic
CreationStack() *[]*string
TypeHint() ResolutionTypeHint
NewError(message *string) interface{}
Resolve(context IResolveContext) interface{}
ToJSON() interface{}
ToString() *string
ToStringList() *[]*string
UnsafeUnwrap() *string
}
Work with secret values in the CDK.
Constructs that need secrets will declare parameters of type `SecretValue`.
The actual values of these secrets should not be committed to your repository, or even end up in the synthesized CloudFormation template. Instead, you should store them in an external system like AWS Secrets Manager or SSM Parameter Store, and you can reference them by calling `SecretValue.secretsManager()` or `SecretValue.ssmSecure()`.
You can use `SecretValue.unsafePlainText()` to construct a `SecretValue` from a literal string, but doing so is highly discouraged.
To make sure secret values don't accidentally end up in readable parts of your infrastructure definition (such as the environment variables of an AWS Lambda Function, where everyone who can read the function definition has access to the secret), using secret values directly is not allowed. You must pass them to constructs that accept `SecretValue` properties, which are guaranteed to use the value only in CloudFormation properties that are write-only.
If you are sure that what you are doing is safe, you can call `secretValue.unsafeUnwrap()` to access the protected string of the secret value.
(If you are writing something like an AWS Lambda Function and need to access a secret inside it, make the API call to `GetSecretValue` directly inside your Lamba's code, instead of using environment variables.)
Example:
// Read the secret from Secrets Manager
pipeline := codepipeline.NewPipeline(this, jsii.String("MyPipeline"))
sourceOutput := codepipeline.NewArtifact()
sourceAction := codepipeline_actions.NewGitHubSourceAction(&GitHubSourceActionProps{
ActionName: jsii.String("GitHub_Source"),
Owner: jsii.String("awslabs"),
Repo: jsii.String("aws-cdk"),
OauthToken: awscdk.SecretValue_SecretsManager(jsii.String("my-github-token")),
Output: sourceOutput,
Branch: jsii.String("develop"),
})
pipeline.AddStage(&StageOptions{
StageName: jsii.String("Source"),
Actions: []IAction{
sourceAction,
},
})
func NewSecretValue(protectedValue interface{}, options *IntrinsicProps) SecretValue
Construct a SecretValue (do not use!).
Do not use the constructor directly: use one of the factory functions on the class instead.
func SecretValue_CfnDynamicReference(ref CfnDynamicReference) SecretValue
Obtain the secret value through a CloudFormation dynamic reference.
If possible, use `SecretValue.ssmSecure` or `SecretValue.secretsManager` directly.
func SecretValue_CfnParameter(param CfnParameter) SecretValue
Obtain the secret value through a CloudFormation parameter.
Generally, this is not a recommended approach. AWS Secrets Manager is the recommended way to reference secrets.
func SecretValue_PlainText(secret *string) SecretValue
Construct a literal secret value for use with secret-aware constructs.
Do not use this method for any secrets that you care about! The value will be visible to anyone who has access to the CloudFormation template (via the AWS Console, SDKs, or CLI).
The only reasonable use case for using this method is when you are testing. Deprecated: Use `unsafePlainText()` instead.
func SecretValue_ResourceAttribute(attr *string) SecretValue
Use a resource's output as secret value.
func SecretValue_SecretsManager(secretId *string, options *SecretsManagerSecretOptions) SecretValue
Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager.
If you rotate the value in the Secret, you must also change at least one property on the resource where you are using the secret, to force CloudFormation to re-read the secret.
func SecretValue_UnsafePlainText(secret *string) SecretValue
Construct a literal secret value for use with secret-aware constructs.
Do not use this method for any secrets that you care about! The value will be visible to anyone who has access to the CloudFormation template (via the AWS Console, SDKs, or CLI).
The primary use case for using this method is when you are testing.
The other use case where this is appropriate is when constructing a JSON secret. For example, a JSON secret might have multiple fields where only some are actual secret values.
Example:
var secret SecretValue
jsonSecret := map[string]SecretValue{
"username": awscdk.SecretValue_unsafePlainText(jsii.String("myUsername")),
"password": secret,
}
type SecretsManagerSecretOptions struct {
JsonField *string `field:"optional" json:"jsonField" yaml:"jsonField"`
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
VersionStage *string `field:"optional" json:"versionStage" yaml:"versionStage"`
}
Options for referencing a secret value from Secrets Manager.
Example:
codebuild.NewBitBucketSourceCredentials(this, jsii.String("CodeBuildBitBucketCreds"), &BitBucketSourceCredentialsProps{
Username: awscdk.SecretValue_SecretsManager(jsii.String("my-bitbucket-creds"), &SecretsManagerSecretOptions{
JsonField: jsii.String("username"),
}),
Password: awscdk.SecretValue_*SecretsManager(jsii.String("my-bitbucket-creds"), &SecretsManagerSecretOptions{
JsonField: jsii.String("password"),
}),
})
Represents the amount of digital storage.
The amount can be specified either as a literal value (e.g: `10`) which cannot be negative, or as an unresolved number token.
When the amount is passed as a token, unit conversion is not possible.
Example:
var myFileSystem IFileSystem
var myJobRole Role
myFileSystem.GrantRead(myJobRole)
jobDefn := batch.NewEcsJobDefinition(this, jsii.String("JobDefn"), &EcsJobDefinitionProps{
Container: batch.NewEcsEc2ContainerDefinition(this, jsii.String("containerDefn"), &EcsEc2ContainerDefinitionProps{
Image: ecs.ContainerImage_FromRegistry(jsii.String("public.ecr.aws/amazonlinux/amazonlinux:latest")),
Memory: cdk.Size_Mebibytes(jsii.Number(2048)),
Cpu: jsii.Number(256),
Volumes: []EcsVolume{
batch.EcsVolume_Efs(&EfsVolumeOptions{
Name: jsii.String("myVolume"),
FileSystem: myFileSystem,
ContainerPath: jsii.String("/Volumes/myVolume"),
UseJobRole: jsii.Boolean(true),
}),
},
JobRole: myJobRole,
}),
})
Create a Storage representing an amount bytes.
Returns: a new `Size` instance.
Create a Storage representing an amount gibibytes.
1 GiB = 1024 MiB.
Returns: a new `Size` instance.
Create a Storage representing an amount kibibytes.
1 KiB = 1024 bytes.
Returns: a new `Size` instance.
Create a Storage representing an amount mebibytes.
1 MiB = 1024 KiB.
Returns: a new `Size` instance.
Create a Storage representing an amount pebibytes.
1 PiB = 1024 TiB.
Returns: a new `Size` instance.
type SizeConversionOptions struct {
Rounding SizeRoundingBehavior `field:"optional" json:"rounding" yaml:"rounding"`
}
Options for how to convert time to a different unit.
Example:
awscdk.Size_Mebibytes(jsii.Number(2)).ToKibibytes() // yields 2048
awscdk.Size_Kibibytes(jsii.Number(2050)).ToMebibytes(&SizeConversionOptions{
Rounding: awscdk.SizeRoundingBehavior_FLOOR,
})
type SizeRoundingBehavior string
Rounding behaviour when converting between units of `Size`.
Example:
awscdk.Size_Mebibytes(jsii.Number(2)).ToKibibytes() // yields 2048
awscdk.Size_Kibibytes(jsii.Number(2050)).ToMebibytes(&SizeConversionOptions{
Rounding: awscdk.SizeRoundingBehavior_FLOOR,
})
const ( SizeRoundingBehavior_FAIL SizeRoundingBehavior = "FAIL" SizeRoundingBehavior_FLOOR SizeRoundingBehavior = "FLOOR" SizeRoundingBehavior_NONE SizeRoundingBehavior = "NONE" )
A root construct which represents a single CloudFormation stack.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
var bucket IBucket
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
dynamodb.NewTable(stack, jsii.String("Table"), &TableProps{
PartitionKey: &Attribute{
Name: jsii.String("id"),
Type: dynamodb.AttributeType_STRING,
},
ImportSource: &ImportSourceSpecification{
CompressionType: dynamodb.InputCompressionType_GZIP,
InputFormat: dynamodb.InputFormat_Csv(&CsvOptions{
Delimiter: jsii.String(","),
HeaderList: []*string{
jsii.String("id"),
jsii.String("name"),
},
}),
Bucket: *Bucket,
KeyPrefix: jsii.String("prefix"),
},
})
Looks up the first stack scope in which `construct` is defined.
Fails if there is no stack up the tree.
Looks up the first stack scope in which `construct` is defined.
Fails if there is no stack up the tree.
type StackProps struct {
AnalyticsReporting *bool `field:"optional" json:"analyticsReporting" yaml:"analyticsReporting"`
CrossRegionReferences *bool `field:"optional" json:"crossRegionReferences" yaml:"crossRegionReferences"`
Description *string `field:"optional" json:"description" yaml:"description"`
Env *Environment `field:"optional" json:"env" yaml:"env"`
NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"`
PermissionsBoundary PermissionsBoundary `field:"optional" json:"permissionsBoundary" yaml:"permissionsBoundary"`
PropertyInjectors *[]IPropertyInjector `field:"optional" json:"propertyInjectors" yaml:"propertyInjectors"`
StackName *string `field:"optional" json:"stackName" yaml:"stackName"`
SuppressTemplateIndentation *bool `field:"optional" json:"suppressTemplateIndentation" yaml:"suppressTemplateIndentation"`
Synthesizer IStackSynthesizer `field:"optional" json:"synthesizer" yaml:"synthesizer"`
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
TerminationProtection *bool `field:"optional" json:"terminationProtection" yaml:"terminationProtection"`
}
Example:
stack1 := awscdk.Newstack(app, jsii.String("Stack1"), &StackProps{
Env: &Environment{
Region: jsii.String("us-east-1"),
},
CrossRegionReferences: jsii.Boolean(true),
})
cert := acm.NewCertificate(stack1, jsii.String("Cert"), &CertificateProps{
DomainName: jsii.String("*.example.com"),
Validation: acm.CertificateValidation_FromDns(route53.PublicHostedZone_FromHostedZoneId(stack1, jsii.String("Zone"), jsii.String("Z0329774B51CGXTDQV3X"))),
})
stack2 := awscdk.Newstack(app, jsii.String("Stack2"), &StackProps{
Env: &Environment{
Region: jsii.String("us-east-2"),
},
CrossRegionReferences: jsii.Boolean(true),
})
cloudfront.NewDistribution(stack2, jsii.String("Distribution"), &DistributionProps{
DefaultBehavior: &BehaviorOptions{
Origin: origins.NewHttpOrigin(jsii.String("example.com")),
},
DomainNames: []*string{
jsii.String("dev.example.com"),
},
Certificate: cert,
})
Base class for implementing an IStackSynthesizer.
This class needs to exist to provide public surface area for external implementations of stack synthesizers. The protected methods give access to functions that are otherwise.
An abstract application modeling unit consisting of Stacks that should be deployed together.
Derive a subclass of `Stage` and use it to model a single instance of your application.
You can then instantiate your subclass multiple times to model multiple copies of your application which should be be deployed to different environments.
Example:
var pipeline CodePipeline
europeWave := pipeline.AddWave(jsii.String("Europe"))
europeWave.AddStage(
NewMyApplicationStage(this, jsii.String("Ireland"), &StageProps{
Env: &Environment{
Region: jsii.String("eu-west-1"),
},
}))
europeWave.AddStage(
NewMyApplicationStage(this, jsii.String("Germany"), &StageProps{
Env: &Environment{
Region: jsii.String("eu-central-1"),
},
}))
Return the app that is the root of the construct tree, if available.
Return the stage this construct is contained with, if available.
If called on a nested stage, returns its parent.
type StageProps struct {
Env *Environment `field:"optional" json:"env" yaml:"env"`
Outdir *string `field:"optional" json:"outdir" yaml:"outdir"`
PermissionsBoundary PermissionsBoundary `field:"optional" json:"permissionsBoundary" yaml:"permissionsBoundary"`
PolicyValidationBeta1 *[]IPolicyValidationPluginBeta1 `field:"optional" json:"policyValidationBeta1" yaml:"policyValidationBeta1"`
PropertyInjectors *[]IPropertyInjector `field:"optional" json:"propertyInjectors" yaml:"propertyInjectors"`
StageName *string `field:"optional" json:"stageName" yaml:"stageName"`
}
Initialization props for a stage.
Example:
var app App
awscdk.NewStage(app, jsii.String("DevStage"))
awscdk.NewStage(app, jsii.String("BetaStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_FromName(jsii.String("beta-permissions-boundary")),
})
awscdk.NewStage(app, jsii.String("GammaStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_*FromName(jsii.String("prod-permissions-boundary")),
})
awscdk.NewStage(app, jsii.String("ProdStage"), &StageProps{
PermissionsBoundary: awscdk.PermissionsBoundary_*FromName(jsii.String("prod-permissions-boundary")),
})
type StageSynthesisOptions struct {
AspectStabilization *bool `field:"optional" json:"aspectStabilization" yaml:"aspectStabilization"`
ErrorOnDuplicateSynth *bool `field:"optional" json:"errorOnDuplicateSynth" yaml:"errorOnDuplicateSynth"`
Force *bool `field:"optional" json:"force" yaml:"force"`
SkipValidation *bool `field:"optional" json:"skipValidation" yaml:"skipValidation"`
ValidateOnSynthesis *bool `field:"optional" json:"validateOnSynthesis" yaml:"validateOnSynthesis"`
}
Options for assembly synthesis.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
stageSynthesisOptions := &StageSynthesisOptions{
AspectStabilization: jsii.Boolean(false),
ErrorOnDuplicateSynth: jsii.Boolean(false),
Force: jsii.Boolean(false),
SkipValidation: jsii.Boolean(false),
ValidateOnSynthesis: jsii.Boolean(false),
}
type StringConcat interface {
IFragmentConcatenator
Join(left interface{}, right interface{}) interface{}
}
Converts all fragments to strings and concats those.
Drops 'undefined's.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" stringConcat := cdk.NewStringConcat()
func NewStringConcat() StringConcat
Determines how symlinks are followed.
const ( SymlinkFollowMode_NEVER SymlinkFollowMode = "NEVER" SymlinkFollowMode_ALWAYS SymlinkFollowMode = "ALWAYS" SymlinkFollowMode_EXTERNAL SymlinkFollowMode = "EXTERNAL" SymlinkFollowMode_BLOCK_EXTERNAL SymlinkFollowMode = "BLOCK_EXTERNAL" )
type SynthesizeStackArtifactOptions struct {
AdditionalDependencies *[]*string `field:"optional" json:"additionalDependencies" yaml:"additionalDependencies"`
AssumeRoleAdditionalOptions *map[string]interface{} `field:"optional" json:"assumeRoleAdditionalOptions" yaml:"assumeRoleAdditionalOptions"`
AssumeRoleArn *string `field:"optional" json:"assumeRoleArn" yaml:"assumeRoleArn"`
AssumeRoleExternalId *string `field:"optional" json:"assumeRoleExternalId" yaml:"assumeRoleExternalId"`
BootstrapStackVersionSsmParameter *string `field:"optional" json:"bootstrapStackVersionSsmParameter" yaml:"bootstrapStackVersionSsmParameter"`
CloudFormationExecutionRoleArn *string `field:"optional" json:"cloudFormationExecutionRoleArn" yaml:"cloudFormationExecutionRoleArn"`
LookupRole *cloudassemblyschema.BootstrapRole `field:"optional" json:"lookupRole" yaml:"lookupRole"`
Parameters *map[string]*string `field:"optional" json:"parameters" yaml:"parameters"`
RequiresBootstrapStackVersion *float64 `field:"optional" json:"requiresBootstrapStackVersion" yaml:"requiresBootstrapStackVersion"`
StackTemplateAssetObjectUrl *string `field:"optional" json:"stackTemplateAssetObjectUrl" yaml:"stackTemplateAssetObjectUrl"`
}
Stack artifact options.
A subset of `cxschema.AwsCloudFormationStackProperties` of optional settings that need to be configurable by synthesizers, plus `additionalDependencies`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
synthesizeStackArtifactOptions := &SynthesizeStackArtifactOptions{
AdditionalDependencies: []*string{
jsii.String("additionalDependencies"),
},
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleArn: jsii.String("assumeRoleArn"),
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
CloudFormationExecutionRoleArn: jsii.String("cloudFormationExecutionRoleArn"),
LookupRole: &BootstrapRole{
Arn: jsii.String("arn"),
// the properties below are optional
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
BootstrapStackVersionSsmParameter: jsii.String("bootstrapStackVersionSsmParameter"),
RequiresBootstrapStackVersion: jsii.Number(123),
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
RequiresBootstrapStackVersion: jsii.Number(123),
StackTemplateAssetObjectUrl: jsii.String("stackTemplateAssetObjectUrl"),
}
The Tag Aspect will handle adding a tag to this node and cascading tags to children.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
tag := cdk.NewTag(jsii.String("key"), jsii.String("value"), &TagProps{
ApplyToLaunchedInstances: jsii.Boolean(false),
ExcludeResourceTypes: []*string{
jsii.String("excludeResourceTypes"),
},
IncludeResourceTypes: []*string{
jsii.String("includeResourceTypes"),
},
Priority: jsii.Number(123),
})
TagManager facilitates a common implementation of tagging for Constructs.
Normally, you do not need to use this class, as the CloudFormation specification will indicate which resources are taggable. However, sometimes you will need this to make custom resources taggable. Used `tagManager.renderedTags` to obtain a value that will resolve to the tags at synthesis time.
Example:
type myConstruct struct {
Resource
tags
}
func newMyConstruct(scope Construct, id *string) *myConstruct {
this := &myConstruct{}
newResource_Override(this, scope, id)
awscdk.NewCfnResource(this, jsii.String("Resource"), &CfnResourceProps{
Type: jsii.String("Whatever::The::Type"),
Properties: map[string]interface{}{
// ...
"Tags": this.tags.renderedTags,
},
})
return this
}
func NewTagManager(tagType TagType, resourceTypeName *string, initialTags interface{}, options *TagManagerOptions) TagManager
func TagManager_Of(construct interface{}) TagManager
Return the TagManager associated with the given construct, if any.
type TagManagerOptions struct {
TagPropertyName *string `field:"optional" json:"tagPropertyName" yaml:"tagPropertyName"`
}
Options to configure TagManager behavior.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
tagManagerOptions := &TagManagerOptions{
TagPropertyName: jsii.String("tagPropertyName"),
}
type TagProps struct {
ApplyToLaunchedInstances *bool `field:"optional" json:"applyToLaunchedInstances" yaml:"applyToLaunchedInstances"`
ExcludeResourceTypes *[]*string `field:"optional" json:"excludeResourceTypes" yaml:"excludeResourceTypes"`
IncludeResourceTypes *[]*string `field:"optional" json:"includeResourceTypes" yaml:"includeResourceTypes"`
Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
}
Properties for a tag.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
tagProps := &TagProps{
ApplyToLaunchedInstances: jsii.Boolean(false),
ExcludeResourceTypes: []*string{
jsii.String("excludeResourceTypes"),
},
IncludeResourceTypes: []*string{
jsii.String("includeResourceTypes"),
},
Priority: jsii.Number(123),
}
Example:
type myConstruct struct {
Resource
tags
}
func newMyConstruct(scope Construct, id *string) *myConstruct {
this := &myConstruct{}
newResource_Override(this, scope, id)
awscdk.NewCfnResource(this, jsii.String("Resource"), &CfnResourceProps{
Type: jsii.String("Whatever::The::Type"),
Properties: map[string]interface{}{
// ...
"Tags": this.tags.renderedTags,
},
})
return this
}
Manages AWS tags for all resources within a construct scope.
Example:
var mesh Mesh
var service Service
node := appmesh.NewVirtualNode(this, jsii.String("node"), &VirtualNodeProps{
Mesh: Mesh,
ServiceDiscovery: appmesh.ServiceDiscovery_CloudMap(service),
Listeners: []VirtualNodeListener{
appmesh.VirtualNodeListener_Http(&HttpVirtualNodeListenerOptions{
Port: jsii.Number(8080),
HealthCheck: appmesh.HealthCheck_Http(&HttpHealthCheckOptions{
HealthyThreshold: jsii.Number(3),
Interval: awscdk.Duration_Seconds(jsii.Number(5)),
Path: jsii.String("/ping"),
Timeout: awscdk.Duration_*Seconds(jsii.Number(2)),
UnhealthyThreshold: jsii.Number(2),
}),
Timeout: &HttpTimeout{
Idle: awscdk.Duration_*Seconds(jsii.Number(5)),
},
}),
},
BackendDefaults: &BackendDefaults{
TlsClientPolicy: &TlsClientPolicy{
Validation: &TlsValidation{
Trust: appmesh.TlsValidationTrust_File(jsii.String("/keys/local_cert_chain.pem")),
},
},
},
AccessLog: appmesh.AccessLog_FromFilePath(jsii.String("/dev/stdout")),
})
cdk.Tags_Of(node).Add(jsii.String("Environment"), jsii.String("Dev"))
Returns the tags API for this scope.
type TimeConversionOptions struct {
Integral *bool `field:"optional" json:"integral" yaml:"integral"`
}
Options for how to convert time to a different unit.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
timeConversionOptions := &TimeConversionOptions{
Integral: jsii.Boolean(false),
}
type TimeZone interface {
TimezoneName() *string
}
Canonical names of the IANA time zones, derived from the IANA Time Zone Database.
For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var resource someScalableResource
capacity := resource.autoScaleCapacity(&caps{
minCapacity: jsii.Number(1),
maxCapacity: jsii.Number(50),
})
capacity.scaleOnSchedule(jsii.String("PrescaleInTheMorning"), &ScalingSchedule{
Schedule: appscaling.Schedule_Cron(&CronOptions{
Hour: jsii.String("8"),
Minute: jsii.String("0"),
}),
MinCapacity: jsii.Number(20),
TimeZone: awscdk.TimeZone_AMERICA_DENVER(),
})
capacity.scaleOnSchedule(jsii.String("AllowDownscalingAtNight"), &ScalingSchedule{
Schedule: appscaling.Schedule_*Cron(&CronOptions{
Hour: jsii.String("20"),
Minute: jsii.String("0"),
}),
MinCapacity: jsii.Number(1),
TimeZone: awscdk.TimeZone_AMERICA_DENVER(),
})
func TimeZone_AFRICA_ABIDJAN() TimeZone
func TimeZone_AFRICA_ALGIERS() TimeZone
func TimeZone_AFRICA_BISSAU() TimeZone
func TimeZone_AFRICA_CAIRO() TimeZone
func TimeZone_AFRICA_CASABLANCA() TimeZone
func TimeZone_AFRICA_CEUTA() TimeZone
func TimeZone_AFRICA_EL_AAIUN() TimeZone
func TimeZone_AFRICA_JOHANNESBURG() TimeZone
func TimeZone_AFRICA_JUBA() TimeZone
func TimeZone_AFRICA_KHARTOUM() TimeZone
func TimeZone_AFRICA_LAGOS() TimeZone
func TimeZone_AFRICA_MAPUTO() TimeZone
func TimeZone_AFRICA_MONROVIA() TimeZone
func TimeZone_AFRICA_NAIROBI() TimeZone
func TimeZone_AFRICA_NDJAMENA() TimeZone
func TimeZone_AFRICA_SAO_TOME() TimeZone
func TimeZone_AFRICA_TRIPOLI() TimeZone
func TimeZone_AFRICA_TUNIS() TimeZone
func TimeZone_AFRICA_WINDHOEK() TimeZone
func TimeZone_AMERICA_ADAK() TimeZone
func TimeZone_AMERICA_ANCHORAGE() TimeZone
func TimeZone_AMERICA_ARAGUAINA() TimeZone
func TimeZone_AMERICA_ARGENTINA_BUENOS_AIRES() TimeZone
func TimeZone_AMERICA_ARGENTINA_CATAMARCA() TimeZone
func TimeZone_AMERICA_ARGENTINA_CORDOBA() TimeZone
func TimeZone_AMERICA_ARGENTINA_JUJUY() TimeZone
func TimeZone_AMERICA_ARGENTINA_LA_RIOJA() TimeZone
func TimeZone_AMERICA_ARGENTINA_MENDOZA() TimeZone
func TimeZone_AMERICA_ARGENTINA_RIO_GALLEGOS() TimeZone
func TimeZone_AMERICA_ARGENTINA_SALTA() TimeZone
func TimeZone_AMERICA_ARGENTINA_SAN_JUAN() TimeZone
func TimeZone_AMERICA_ARGENTINA_SAN_LUIS() TimeZone
func TimeZone_AMERICA_ARGENTINA_TUCUMAN() TimeZone
func TimeZone_AMERICA_ARGENTINA_USHUAIA() TimeZone
func TimeZone_AMERICA_ASUNCION() TimeZone
func TimeZone_AMERICA_BAHIA() TimeZone
func TimeZone_AMERICA_BARBADOS() TimeZone
func TimeZone_AMERICA_BELEM() TimeZone
func TimeZone_AMERICA_BELIZE() TimeZone
func TimeZone_AMERICA_BOA_VISTA() TimeZone
func TimeZone_AMERICA_BOGOTA() TimeZone
func TimeZone_AMERICA_BOISE() TimeZone
func TimeZone_AMERICA_CAMBRIDGE_BAY() TimeZone
func TimeZone_AMERICA_CANCUN() TimeZone
func TimeZone_AMERICA_CARACAS() TimeZone
func TimeZone_AMERICA_CAYENNE() TimeZone
func TimeZone_AMERICA_CHICAGO() TimeZone
func TimeZone_AMERICA_CHIHUAHUA() TimeZone
func TimeZone_AMERICA_CIUDAD_JUAREZ() TimeZone
func TimeZone_AMERICA_COSTA_RICA() TimeZone
func TimeZone_AMERICA_CUIABA() TimeZone
func TimeZone_AMERICA_DANMARKSHAVN() TimeZone
func TimeZone_AMERICA_DAWSON() TimeZone
func TimeZone_AMERICA_DAWSON_CREEK() TimeZone
func TimeZone_AMERICA_DENVER() TimeZone
func TimeZone_AMERICA_DETROIT() TimeZone
func TimeZone_AMERICA_EDMONTON() TimeZone
func TimeZone_AMERICA_EIRUNEPE() TimeZone
func TimeZone_AMERICA_EL_SALVADOR() TimeZone
func TimeZone_AMERICA_FORTALEZA() TimeZone
func TimeZone_AMERICA_FORT_NELSON() TimeZone
func TimeZone_AMERICA_GLACE_BAY() TimeZone
func TimeZone_AMERICA_GOOSE_BAY() TimeZone
func TimeZone_AMERICA_GUATEMALA() TimeZone
func TimeZone_AMERICA_GUAYAQUIL() TimeZone
func TimeZone_AMERICA_GUYANA() TimeZone
func TimeZone_AMERICA_HALIFAX() TimeZone
func TimeZone_AMERICA_HAVANA() TimeZone
func TimeZone_AMERICA_HERMOSILLO() TimeZone
func TimeZone_AMERICA_INDIANA_INDIANAPOLIS() TimeZone
func TimeZone_AMERICA_INDIANA_KNOX() TimeZone
func TimeZone_AMERICA_INDIANA_MARENGO() TimeZone
func TimeZone_AMERICA_INDIANA_PETERSBURG() TimeZone
func TimeZone_AMERICA_INDIANA_TELL_CITY() TimeZone
func TimeZone_AMERICA_INDIANA_VEVAY() TimeZone
func TimeZone_AMERICA_INDIANA_VINCENNES() TimeZone
func TimeZone_AMERICA_INDIANA_WINAMAC() TimeZone
func TimeZone_AMERICA_INUVIK() TimeZone
func TimeZone_AMERICA_IQALUIT() TimeZone
func TimeZone_AMERICA_JAMAICA() TimeZone
func TimeZone_AMERICA_JUNEAU() TimeZone
func TimeZone_AMERICA_KENTUCKY_LOUISVILLE() TimeZone
func TimeZone_AMERICA_KENTUCKY_MONTICELLO() TimeZone
func TimeZone_AMERICA_LA_PAZ() TimeZone
func TimeZone_AMERICA_LIMA() TimeZone
func TimeZone_AMERICA_LOS_ANGELES() TimeZone
func TimeZone_AMERICA_MACEIO() TimeZone
func TimeZone_AMERICA_MANAGUA() TimeZone
func TimeZone_AMERICA_MANAUS() TimeZone
func TimeZone_AMERICA_MARTINIQUE() TimeZone
func TimeZone_AMERICA_MATAMOROS() TimeZone
func TimeZone_AMERICA_MAZATLAN() TimeZone
func TimeZone_AMERICA_MENOMINEE() TimeZone
func TimeZone_AMERICA_MERIDA() TimeZone
func TimeZone_AMERICA_METLAKATLA() TimeZone
func TimeZone_AMERICA_MEXICO_CITY() TimeZone
func TimeZone_AMERICA_MIQUELON() TimeZone
func TimeZone_AMERICA_MONCTON() TimeZone
func TimeZone_AMERICA_MONTERREY() TimeZone
func TimeZone_AMERICA_MONTEVIDEO() TimeZone
func TimeZone_AMERICA_NEW_YORK() TimeZone
func TimeZone_AMERICA_NOME() TimeZone
func TimeZone_AMERICA_NORONHA() TimeZone
func TimeZone_AMERICA_NORTH_DAKOTA_BEULAH() TimeZone
func TimeZone_AMERICA_NORTH_DAKOTA_CENTER() TimeZone
func TimeZone_AMERICA_NORTH_DAKOTA_NEW_SALEM() TimeZone
func TimeZone_AMERICA_NUUK() TimeZone
func TimeZone_AMERICA_OJINAGA() TimeZone
func TimeZone_AMERICA_PANAMA() TimeZone
func TimeZone_AMERICA_PARAMARIBO() TimeZone
func TimeZone_AMERICA_PHOENIX() TimeZone
func TimeZone_AMERICA_PORTO_VELHO() TimeZone
func TimeZone_AMERICA_PORT_MINUS_AU_MINUS_PRINCE() TimeZone
func TimeZone_AMERICA_PUERTO_RICO() TimeZone
func TimeZone_AMERICA_PUNTA_ARENAS() TimeZone
func TimeZone_AMERICA_RANKIN_INLET() TimeZone
func TimeZone_AMERICA_RECIFE() TimeZone
func TimeZone_AMERICA_REGINA() TimeZone
func TimeZone_AMERICA_RESOLUTE() TimeZone
func TimeZone_AMERICA_RIO_BRANCO() TimeZone
func TimeZone_AMERICA_SANTAREM() TimeZone
func TimeZone_AMERICA_SANTIAGO() TimeZone
func TimeZone_AMERICA_SANTO_DOMINGO() TimeZone
func TimeZone_AMERICA_SAO_PAULO() TimeZone
func TimeZone_AMERICA_SCORESBYSUND() TimeZone
func TimeZone_AMERICA_SITKA() TimeZone
func TimeZone_AMERICA_ST_JOHNS() TimeZone
func TimeZone_AMERICA_SWIFT_CURRENT() TimeZone
func TimeZone_AMERICA_TEGUCIGALPA() TimeZone
func TimeZone_AMERICA_THULE() TimeZone
func TimeZone_AMERICA_TIJUANA() TimeZone
func TimeZone_AMERICA_TORONTO() TimeZone
func TimeZone_AMERICA_VANCOUVER() TimeZone
func TimeZone_AMERICA_WHITEHORSE() TimeZone
func TimeZone_AMERICA_WINNIPEG() TimeZone
func TimeZone_AMERICA_YAKUTAT() TimeZone
func TimeZone_AMERICA_YELLOWKNIFE() TimeZone
func TimeZone_ANTARCTICA_CASEY() TimeZone
func TimeZone_ANTARCTICA_DAVIS() TimeZone
func TimeZone_ANTARCTICA_MACQUARIE() TimeZone
func TimeZone_ANTARCTICA_MAWSON() TimeZone
func TimeZone_ANTARCTICA_PALMER() TimeZone
func TimeZone_ANTARCTICA_ROTHERA() TimeZone
func TimeZone_ANTARCTICA_TROLL() TimeZone
func TimeZone_ASIA_ALMATY() TimeZone
func TimeZone_ASIA_AMMAN() TimeZone
func TimeZone_ASIA_ANADYR() TimeZone
func TimeZone_ASIA_AQTAU() TimeZone
func TimeZone_ASIA_AQTOBE() TimeZone
func TimeZone_ASIA_ASHGABAT() TimeZone
func TimeZone_ASIA_ATYRAU() TimeZone
func TimeZone_ASIA_BAGHDAD() TimeZone
func TimeZone_ASIA_BAKU() TimeZone
func TimeZone_ASIA_BANGKOK() TimeZone
func TimeZone_ASIA_BARNAUL() TimeZone
func TimeZone_ASIA_BEIRUT() TimeZone
func TimeZone_ASIA_BISHKEK() TimeZone
func TimeZone_ASIA_CHITA() TimeZone
func TimeZone_ASIA_CHOIBALSAN() TimeZone
func TimeZone_ASIA_COLOMBO() TimeZone
func TimeZone_ASIA_DAMASCUS() TimeZone
func TimeZone_ASIA_DHAKA() TimeZone
func TimeZone_ASIA_DILI() TimeZone
func TimeZone_ASIA_DUBAI() TimeZone
func TimeZone_ASIA_DUSHANBE() TimeZone
func TimeZone_ASIA_FAMAGUSTA() TimeZone
func TimeZone_ASIA_GAZA() TimeZone
func TimeZone_ASIA_HEBRON() TimeZone
func TimeZone_ASIA_HONG_KONG() TimeZone
func TimeZone_ASIA_HOVD() TimeZone
func TimeZone_ASIA_HO_CHI_MINH() TimeZone
func TimeZone_ASIA_IRKUTSK() TimeZone
func TimeZone_ASIA_JAKARTA() TimeZone
func TimeZone_ASIA_JAYAPURA() TimeZone
func TimeZone_ASIA_JERUSALEM() TimeZone
func TimeZone_ASIA_KABUL() TimeZone
func TimeZone_ASIA_KAMCHATKA() TimeZone
func TimeZone_ASIA_KARACHI() TimeZone
func TimeZone_ASIA_KOLKATA() TimeZone
func TimeZone_ASIA_KRASNOYARSK() TimeZone
func TimeZone_ASIA_KUCHING() TimeZone
func TimeZone_ASIA_MACAU() TimeZone
func TimeZone_ASIA_MAGADAN() TimeZone
func TimeZone_ASIA_MAKASSAR() TimeZone
func TimeZone_ASIA_MANILA() TimeZone
func TimeZone_ASIA_NICOSIA() TimeZone
func TimeZone_ASIA_NOVOKUZNETSK() TimeZone
func TimeZone_ASIA_NOVOSIBIRSK() TimeZone
func TimeZone_ASIA_OMSK() TimeZone
func TimeZone_ASIA_ORAL() TimeZone
func TimeZone_ASIA_PONTIANAK() TimeZone
func TimeZone_ASIA_PYONGYANG() TimeZone
func TimeZone_ASIA_QATAR() TimeZone
func TimeZone_ASIA_QOSTANAY() TimeZone
func TimeZone_ASIA_QYZYLORDA() TimeZone
func TimeZone_ASIA_RIYADH() TimeZone
func TimeZone_ASIA_SAKHALIN() TimeZone
func TimeZone_ASIA_SEOUL() TimeZone
func TimeZone_ASIA_SHANGHAI() TimeZone
func TimeZone_ASIA_SINGAPORE() TimeZone
func TimeZone_ASIA_SREDNEKOLYMSK() TimeZone
func TimeZone_ASIA_TAIPEI() TimeZone
func TimeZone_ASIA_TASHKENT() TimeZone
func TimeZone_ASIA_TBILISI() TimeZone
func TimeZone_ASIA_TEHRAN() TimeZone
func TimeZone_ASIA_THIMPHU() TimeZone
func TimeZone_ASIA_TOKYO() TimeZone
func TimeZone_ASIA_TOMSK() TimeZone
func TimeZone_ASIA_ULAANBAATAR() TimeZone
func TimeZone_ASIA_URUMQI() TimeZone
func TimeZone_ASIA_UST_MINUS_NERA() TimeZone
func TimeZone_ASIA_VLADIVOSTOK() TimeZone
func TimeZone_ASIA_YAKUTSK() TimeZone
func TimeZone_ASIA_YANGON() TimeZone
func TimeZone_ASIA_YEKATERINBURG() TimeZone
func TimeZone_ASIA_YEREVAN() TimeZone
func TimeZone_ATLANTIC_AZORES() TimeZone
func TimeZone_ATLANTIC_BERMUDA() TimeZone
func TimeZone_ATLANTIC_CANARY() TimeZone
func TimeZone_ATLANTIC_CAPE_VERDE() TimeZone
func TimeZone_ATLANTIC_FAROE() TimeZone
func TimeZone_ATLANTIC_MADEIRA() TimeZone
func TimeZone_ATLANTIC_SOUTH_GEORGIA() TimeZone
func TimeZone_ATLANTIC_STANLEY() TimeZone
func TimeZone_AUSTRALIA_ADELAIDE() TimeZone
func TimeZone_AUSTRALIA_BRISBANE() TimeZone
func TimeZone_AUSTRALIA_BROKEN_HILL() TimeZone
func TimeZone_AUSTRALIA_DARWIN() TimeZone
func TimeZone_AUSTRALIA_EUCLA() TimeZone
func TimeZone_AUSTRALIA_HOBART() TimeZone
func TimeZone_AUSTRALIA_LINDEMAN() TimeZone
func TimeZone_AUSTRALIA_LORD_HOWE() TimeZone
func TimeZone_AUSTRALIA_MELBOURNE() TimeZone
func TimeZone_AUSTRALIA_PERTH() TimeZone
func TimeZone_AUSTRALIA_SYDNEY() TimeZone
func TimeZone_CET() TimeZone
func TimeZone_CST6CDT() TimeZone
func TimeZone_EET() TimeZone
func TimeZone_EST() TimeZone
func TimeZone_EST5EDT() TimeZone
func TimeZone_ETC_GMT() TimeZone
func TimeZone_ETC_GMT_MINUS_1() TimeZone
func TimeZone_ETC_GMT_MINUS_2() TimeZone
func TimeZone_ETC_GMT_MINUS_3() TimeZone
func TimeZone_ETC_GMT_MINUS_4() TimeZone
func TimeZone_ETC_GMT_MINUS_5() TimeZone
func TimeZone_ETC_GMT_MINUS_6() TimeZone
func TimeZone_ETC_GMT_MINUS_7() TimeZone
func TimeZone_ETC_GMT_MINUS_8() TimeZone
func TimeZone_ETC_GMT_MINUS_9() TimeZone
func TimeZone_ETC_GMT_MINUS_10() TimeZone
func TimeZone_ETC_GMT_MINUS_11() TimeZone
func TimeZone_ETC_GMT_MINUS_12() TimeZone
func TimeZone_ETC_GMT_MINUS_13() TimeZone
func TimeZone_ETC_GMT_MINUS_14() TimeZone
func TimeZone_ETC_GMT_PLUS_1() TimeZone
func TimeZone_ETC_GMT_PLUS_2() TimeZone
func TimeZone_ETC_GMT_PLUS_3() TimeZone
func TimeZone_ETC_GMT_PLUS_4() TimeZone
func TimeZone_ETC_GMT_PLUS_5() TimeZone
func TimeZone_ETC_GMT_PLUS_6() TimeZone
func TimeZone_ETC_GMT_PLUS_7() TimeZone
func TimeZone_ETC_GMT_PLUS_8() TimeZone
func TimeZone_ETC_GMT_PLUS_9() TimeZone
func TimeZone_ETC_GMT_PLUS_10() TimeZone
func TimeZone_ETC_GMT_PLUS_11() TimeZone
func TimeZone_ETC_GMT_PLUS_12() TimeZone
func TimeZone_ETC_UTC() TimeZone
func TimeZone_EUROPE_ASTRAKHAN() TimeZone
func TimeZone_EUROPE_ATHENS() TimeZone
func TimeZone_EUROPE_BELGRADE() TimeZone
func TimeZone_EUROPE_BERLIN() TimeZone
func TimeZone_EUROPE_BRUSSELS() TimeZone
func TimeZone_EUROPE_BUCHAREST() TimeZone
func TimeZone_EUROPE_BUDAPEST() TimeZone
func TimeZone_EUROPE_CHISINAU() TimeZone
func TimeZone_EUROPE_DUBLIN() TimeZone
func TimeZone_EUROPE_GIBRALTAR() TimeZone
func TimeZone_EUROPE_HELSINKI() TimeZone
func TimeZone_EUROPE_ISTANBUL() TimeZone
func TimeZone_EUROPE_KALININGRAD() TimeZone
func TimeZone_EUROPE_KIROV() TimeZone
func TimeZone_EUROPE_KYIV() TimeZone
func TimeZone_EUROPE_LISBON() TimeZone
func TimeZone_EUROPE_LONDON() TimeZone
func TimeZone_EUROPE_MADRID() TimeZone
func TimeZone_EUROPE_MALTA() TimeZone
func TimeZone_EUROPE_MINSK() TimeZone
func TimeZone_EUROPE_MOSCOW() TimeZone
func TimeZone_EUROPE_PARIS() TimeZone
func TimeZone_EUROPE_PRAGUE() TimeZone
func TimeZone_EUROPE_RIGA() TimeZone
func TimeZone_EUROPE_ROME() TimeZone
func TimeZone_EUROPE_SAMARA() TimeZone
func TimeZone_EUROPE_SARATOV() TimeZone
func TimeZone_EUROPE_SIMFEROPOL() TimeZone
func TimeZone_EUROPE_SOFIA() TimeZone
func TimeZone_EUROPE_TALLINN() TimeZone
func TimeZone_EUROPE_TIRANE() TimeZone
func TimeZone_EUROPE_ULYANOVSK() TimeZone
func TimeZone_EUROPE_VIENNA() TimeZone
func TimeZone_EUROPE_VILNIUS() TimeZone
func TimeZone_EUROPE_VOLGOGRAD() TimeZone
func TimeZone_EUROPE_WARSAW() TimeZone
func TimeZone_EUROPE_ZURICH() TimeZone
func TimeZone_FACTORY() TimeZone
func TimeZone_HST() TimeZone
func TimeZone_INDIAN_CHAGOS() TimeZone
func TimeZone_INDIAN_MALDIVES() TimeZone
func TimeZone_INDIAN_MAURITIUS() TimeZone
func TimeZone_MET() TimeZone
func TimeZone_MST() TimeZone
func TimeZone_MST7MDT() TimeZone
Use this to add a timezone not in this class.
Returns: a new Timezone.
func TimeZone_PACIFIC_APIA() TimeZone
func TimeZone_PACIFIC_BOUGAINVILLE() TimeZone
func TimeZone_PACIFIC_CHATHAM() TimeZone
func TimeZone_PACIFIC_EASTER() TimeZone
func TimeZone_PACIFIC_EFATE() TimeZone
func TimeZone_PACIFIC_FAKAOFO() TimeZone
func TimeZone_PACIFIC_FIJI() TimeZone
func TimeZone_PACIFIC_GALAPAGOS() TimeZone
func TimeZone_PACIFIC_GAMBIER() TimeZone
func TimeZone_PACIFIC_GUADALCANAL() TimeZone
func TimeZone_PACIFIC_GUAM() TimeZone
func TimeZone_PACIFIC_HONOLULU() TimeZone
func TimeZone_PACIFIC_KANTON() TimeZone
func TimeZone_PACIFIC_KIRITIMATI() TimeZone
func TimeZone_PACIFIC_KOSRAE() TimeZone
func TimeZone_PACIFIC_KWAJALEIN() TimeZone
func TimeZone_PACIFIC_MARQUESAS() TimeZone
func TimeZone_PACIFIC_NAURU() TimeZone
func TimeZone_PACIFIC_NIUE() TimeZone
func TimeZone_PACIFIC_NORFOLK() TimeZone
func TimeZone_PACIFIC_NOUMEA() TimeZone
func TimeZone_PACIFIC_PAGO_PAGO() TimeZone
func TimeZone_PACIFIC_PALAU() TimeZone
func TimeZone_PACIFIC_PITCAIRN() TimeZone
func TimeZone_PACIFIC_PORT_MORESBY() TimeZone
func TimeZone_PACIFIC_RAROTONGA() TimeZone
func TimeZone_PACIFIC_TAHITI() TimeZone
func TimeZone_PACIFIC_TARAWA() TimeZone
func TimeZone_PACIFIC_TONGATAPU() TimeZone
func TimeZone_PST8PDT() TimeZone
func TimeZone_WET() TimeZone
Represents a special or lazily-evaluated value.
Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.
Tokens can be embedded into strings while retaining their original semantics.
type TokenComparison interface {
}
An enum-like class that represents the result of comparing two Tokens.
The return type of `Token.compareStrings`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" tokenComparison := cdk.TokenComparison_BOTH_UNRESOLVED()
func TokenComparison_BOTH_UNRESOLVED() TokenComparison
func TokenComparison_DIFFERENT() TokenComparison
func TokenComparison_ONE_UNRESOLVED() TokenComparison
func TokenComparison_SAME() TokenComparison
func Token_CompareStrings(possibleToken1 *string, possibleToken2 *string) TokenComparison
Compare two strings that might contain Tokens with each other.
type Tokenization interface {
}
Less oft-needed functions to manipulate Tokens.
type TokenizedStringFragments interface {
FirstToken() IResolvable
FirstValue() interface{}
Length() *float64
Tokens() *[]IResolvable
AddIntrinsic(value interface{})
AddLiteral(lit interface{})
AddToken(token IResolvable)
Join(concat IFragmentConcatenator) interface{}
MapTokens(mapper ITokenMapper) TokenizedStringFragments
}
Fragments of a concatenated string containing stringified Tokens.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" tokenizedStringFragments := cdk.NewTokenizedStringFragments()
func NewTokenizedStringFragments() TokenizedStringFragments
func Tokenization_ReverseString(s *string) TokenizedStringFragments
Un-encode a string potentially containing encoded tokens.
type TreeInspector interface {
Attributes() *map[string]interface{}
AddAttribute(key *string, value interface{})
}
Inspector that maintains an attribute bag.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import cdk "github.com/aws/aws-cdk-go/awscdk" treeInspector := cdk.NewTreeInspector()
func NewTreeInspector() TreeInspector
type UniqueResourceNameOptions struct {
AllowedSpecialCharacters *string `field:"optional" json:"allowedSpecialCharacters" yaml:"allowedSpecialCharacters"`
MaxLength *float64 `field:"optional" json:"maxLength" yaml:"maxLength"`
Separator *string `field:"optional" json:"separator" yaml:"separator"`
}
Options for creating a unique resource name.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
uniqueResourceNameOptions := &UniqueResourceNameOptions{
AllowedSpecialCharacters: jsii.String("allowedSpecialCharacters"),
MaxLength: jsii.Number(123),
Separator: jsii.String("separator"),
}
type ValidationResult interface {
ErrorMessage() *string
IsSuccess() *bool
Results() ValidationResults
AssertSuccess()
ErrorTree() *string
Prefix(message *string) ValidationResult
}
Representation of validation results.
Models a tree of validation errors so that we have as much information as possible about the failure that occurred.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var validationResults ValidationResults
validationResult := cdk.NewValidationResult(jsii.String("errorMessage"), validationResults)
func NewValidationResult(errorMessage *string, results ValidationResults) ValidationResult
type ValidationResults interface {
IsSuccess() *bool
Results() *[]ValidationResult
SetResults(val *[]ValidationResult)
Collect(result ValidationResult)
ErrorTreeList() *string
Wrap(message *string) ValidationResult
}
A collection of validation results.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var validationResult ValidationResult
validationResults := cdk.NewValidationResults([]ValidationResult{
validationResult,
})
func NewValidationResults(results *[]ValidationResult) ValidationResults