Package software.amazon.awscdk.services.servicecatalog

Interface TemplateRule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TemplateRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:17.665Z")
@Stability(Stable)
public interface TemplateRule
extends software.amazon.jsii.JsiiSerializable

Defines the provisioning template constraints.

Example:

 import software.amazon.awscdk.*;
 Portfolio portfolio;
 CloudFormationProduct product;
 portfolio.constrainCloudFormationParameters(product, CloudFormationRuleConstraintOptions.builder()
         .rule(TemplateRule.builder()
                 .ruleName("testInstanceType")
                 .condition(Fn.conditionEquals(Fn.ref("Environment"), "test"))
                 .assertions(List.of(TemplateRuleAssertion.builder()
                         .assert(Fn.conditionContains(List.of("t2.micro", "t2.small"), Fn.ref("InstanceType")))
                         .description("For test environment, the instance type should be small")
                         .build()))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TemplateRule.Builder	A builder for TemplateRule
static final class	TemplateRule.Jsii$Proxy	An implementation for TemplateRule

Method Summary

Modifier and Type	Method	Description
static TemplateRule.Builder	builder()
List<TemplateRuleAssertion>	getAssertions()	A list of assertions that make up the rule.
default ICfnRuleConditionExpression	getCondition()	Specify when to apply rule with a rule-specific intrinsic function.
String	getRuleName()	Name of the rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssertions

@Stability(Stable)
@NotNull
List<TemplateRuleAssertion> getAssertions()

A list of assertions that make up the rule.

getRuleName

@Stability(Stable)
@NotNull
String getRuleName()

Name of the rule.

getCondition

@Stability(Stable)
@Nullable
default ICfnRuleConditionExpression getCondition()

Specify when to apply rule with a rule-specific intrinsic function.

Default: - no rule condition provided

builder

@Stability(Stable)
static TemplateRule.Builder builder()

Returns:

a TemplateRule.Builder of TemplateRule