Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnInclude_IsCfnElement ¶
func CfnInclude_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 CfnInclude_IsConstruct ¶
func CfnInclude_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnInclude_Override ¶
func NewCfnInclude_Override(c CfnInclude, scope constructs.Construct, id *string, props *CfnIncludeProps)
Types ¶
type CfnInclude ¶
type CfnInclude interface {
awscdk.CfnElement
CreationStack() *[]*string
LogicalId() *string
Node() constructs.Node
Stack() awscdk.Stack
GetCondition(conditionName *string) awscdk.CfnCondition
GetHook(hookLogicalId *string) awscdk.CfnHook
GetMapping(mappingName *string) awscdk.CfnMapping
GetNestedStack(logicalId *string) *IncludedNestedStack
GetOutput(logicalId *string) awscdk.CfnOutput
GetParameter(parameterName *string) awscdk.CfnParameter
GetResource(logicalId *string) awscdk.CfnResource
GetRule(ruleName *string) awscdk.CfnRule
LoadNestedStack(logicalId *string, nestedStackProps *CfnIncludeProps) *IncludedNestedStack
OverrideLogicalId(newLogicalId *string)
ToString() *string
}
Construct to import an existing CloudFormation template file into a CDK application.
All resources defined in the template file can be retrieved by calling the {@link getResource} method. Any modifications made on the returned resource objects will be reflected in the resulting CDK template.
TODO: EXAMPLE
func NewCfnInclude ¶
func NewCfnInclude(scope constructs.Construct, id *string, props *CfnIncludeProps) CfnInclude
type CfnIncludeProps ¶
type CfnIncludeProps struct {
// Path to the template file.
//
// Both JSON and YAML template formats are supported.
TemplateFile *string `json:"templateFile"`
// Specifies the template files that define nested stacks that should be included.
//
// If your template specifies a stack that isn't included here, it won't be created as a NestedStack
// resource, and it won't be accessible from the {@link CfnInclude.getNestedStack} method
// (but will still be accessible from the {@link CfnInclude.getResource} method).
//
// If you include a stack here with an ID that isn't in the template,
// or is in the template but is not a nested stack,
// template creation will fail and an error will be thrown.
LoadNestedStacks *map[string]*CfnIncludeProps `json:"loadNestedStacks"`
// Specifies parameters to be replaced by the values in this mapping.
//
// Any parameters in the template that aren't specified here will be left unmodified.
// If you include a parameter here with an ID that isn't in the template,
// template creation will fail and an error will be thrown.
Parameters *map[string]interface{} `json:"parameters"`
// Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.
//
// If you're vending a Construct using an existing CloudFormation template,
// make sure to pass this as `false`.
//
// **Note**: regardless of whether this option is true or false,
// the {@link CfnInclude.getResource} and related methods always uses the original logical ID of the resource/element,
// as specified in the template file.
PreserveLogicalIds *bool `json:"preserveLogicalIds"`
}
Construction properties of {@link CfnInclude}.
TODO: EXAMPLE
type IncludedNestedStack ¶
type IncludedNestedStack struct {
// The CfnInclude that represents the template, which can be used to access Resources and other template elements.
IncludedTemplate CfnInclude `json:"includedTemplate"`
// The NestedStack object which represents the scope of the template.
Stack awscdk.NestedStack `json:"stack"`
}
The type returned from {@link CfnInclude.getNestedStack}. Contains both the NestedStack object and CfnInclude representations of the child stack.
TODO: EXAMPLE