package awscdk import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/constructs-go/constructs/v10" ) // 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 CfnRule interface { CfnRefElement // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() Stack // Adds an assertion to the rule. AddAssertion(condition ICfnConditionExpression, description *string) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for CfnRule type jsiiProxy_CfnRule struct { jsiiProxy_CfnRefElement } func (j *jsiiProxy_CfnRule) CreationStack() *[]*string { var returns *[]*string _jsii_.Get( j, "creationStack", &returns, ) return returns } func (j *jsiiProxy_CfnRule) LogicalId() *string { var returns *string _jsii_.Get( j, "logicalId", &returns, ) return returns } func (j *jsiiProxy_CfnRule) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_CfnRule) Ref() *string { var returns *string _jsii_.Get( j, "ref", &returns, ) return returns } func (j *jsiiProxy_CfnRule) Stack() Stack { var returns Stack _jsii_.Get( j, "stack", &returns, ) return returns } // Creates and adds a rule. func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule { _init_.Initialize() if err := validateNewCfnRuleParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_CfnRule{} _jsii_.Create( "aws-cdk-lib.CfnRule", []interface{}{scope, id, props}, &j, ) return &j } // Creates and adds a rule. func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.CfnRule", []interface{}{scope, id, props}, c, ) } // 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_IsCfnElement(x interface{}) *bool { _init_.Initialize() if err := validateCfnRule_IsCfnElementParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.CfnRule", "isCfnElement", []interface{}{x}, &returns, ) return returns } // 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_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateCfnRule_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.CfnRule", "isConstruct", []interface{}{x}, &returns, ) return returns } func (c *jsiiProxy_CfnRule) AddAssertion(condition ICfnConditionExpression, description *string) { if err := c.validateAddAssertionParameters(condition, description); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addAssertion", []interface{}{condition, description}, ) } func (c *jsiiProxy_CfnRule) OverrideLogicalId(newLogicalId *string) { if err := c.validateOverrideLogicalIdParameters(newLogicalId); err != nil { panic(err) } _jsii_.InvokeVoid( c, "overrideLogicalId", []interface{}{newLogicalId}, ) } func (c *jsiiProxy_CfnRule) ToString() *string { var returns *string _jsii_.Invoke( c, "toString", nil, // no parameters &returns, ) return returns }