Terraform
Java: Protocols
IAnyProducer
- Implemented By: IAnyProducer
Interface for lazy untyped value producers.
Methods
| Name | Description |
|---|---|
produce | Produce the value. |
produce
public java.lang.Object produce(IResolveContext context)
Produce the value.
contextRequired
- Type: IResolveContext
IAspect
- Implemented By: MigrateIds, IAspect
Represents an Aspect.
Methods
| Name | Description |
|---|---|
visit | All aspects can visit an IConstruct. |
visit
public void visit(IConstruct node)
All aspects can visit an IConstruct.
nodeRequired
- Type: software.constructs.IConstruct
IFragmentConcatenator
- Implemented By: StringConcat, IFragmentConcatenator
Function used to concatenate symbols in the target document language.
Interface so it could potentially be exposed over jsii.
Methods
| Name | Description |
|---|---|
join | Join the fragment on the left and on the right. |
join
public java.lang.Object join(java.lang.Object left, java.lang.Object right)
Join the fragment on the left and on the right.
leftRequired
- Type: java.lang.Object
rightRequired
- Type: java.lang.Object
IImportableConfig
- Implemented By: IImportableConfig
Properties
| Name | Type | Description |
|---|---|---|
importId | java.lang.String | No description. |
terraformResourceType | java.lang.String | No description. |
provider | TerraformProvider | No description. |
importIdRequired
public java.lang.String getImportId();
- Type: java.lang.String
terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
providerOptional
public TerraformProvider getProvider();
- Type: TerraformProvider
IInterpolatingParent
- Implemented By: AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent
Methods
| Name | Description |
|---|---|
interpolationForAttribute | No description. |
interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
- Type: java.lang.String
IListProducer
- Implemented By: IListProducer
Interface for lazy list producers.
Methods
| Name | Description |
|---|---|
produce | Produce the list value. |
produce
public java.util.List< java.lang.String > produce(IResolveContext context)
Produce the list value.
contextRequired
- Type: IResolveContext
IManifest
Properties
| Name | Type | Description |
|---|---|---|
stacks | java.util.Map< java.lang.String, StackManifest> | No description. |
version | java.lang.String | No description. |
stacksRequired
public java.util.Map< java.lang.String, StackManifest > getStacks();
- Type: java.util.Map< java.lang.String, StackManifest>
versionRequired
public java.lang.String getVersion();
- Type: java.lang.String
INumberProducer
- Implemented By: INumberProducer
Interface for lazy number producers.
Methods
| Name | Description |
|---|---|
produce | Produce the number value. |
produce
public java.lang.Number produce(IResolveContext context)
Produce the number value.
contextRequired
- Type: IResolveContext
IPostProcessor
- Implemented By: IPostProcessor
A Token that can post-process the complete resolved value, after resolve() has recursed over it.
Methods
| Name | Description |
|---|---|
postProcess | Process the completely resolved value, after full recursion/resolution has happened. |
postProcess
public java.lang.Object postProcess(java.lang.Object input, IResolveContext context)
Process the completely resolved value, after full recursion/resolution has happened.
inputRequired
- Type: java.lang.Object
contextRequired
- Type: IResolveContext
IRemoteWorkspace
- Implemented By: NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace
IResolvable
- Implemented By: AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, IResolvable
Interface for values that can be resolvable later.
Tokens are special objects that participate in synthesis.
Methods
| Name | Description |
|---|---|
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
resolve
public java.lang.Object resolve(IResolveContext context)
Produce the Token's value at resolution time.
contextRequired
- Type: IResolveContext
toString
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
| Name | Type | Description |
|---|---|---|
creationStack | java.util.List< java.lang.String > | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
creationStackRequired
public java.util.List< java.lang.String > getCreationStack();
- Type: java.util.List< java.lang.String >
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
IResolveContext
- Implemented By: IResolveContext
Current resolution context for tokens.
Methods
| Name | Description |
|---|---|
registerPostProcessor | Use this postprocessor after the entire token structure has been resolved. |
resolve | Resolve an inner object. |
registerPostProcessor
public void registerPostProcessor(IPostProcessor postProcessor)
Use this postprocessor after the entire token structure has been resolved.
postProcessorRequired
- Type: IPostProcessor
resolve
public java.lang.Object resolve(java.lang.Object x)
Resolve an inner object.
xRequired
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
preparing | java.lang.Boolean | True when we are still preparing, false if we're rendering the final output. |
scope | software.constructs.IConstruct | The scope from which resolution has been initiated. |
ignoreEscapes | java.lang.Boolean | True when ${} should not be parsed, and treated as literals. |
iteratorContext | java.lang.String | TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key. |
suppressBraces | java.lang.Boolean | True when ${} should be ommitted (because already inside them), false otherwise. |
warnEscapes | java.lang.Boolean | True when ${} should not be included in the string to be resolved, outputs a warning. |
preparingRequired
public java.lang.Boolean getPreparing();
- Type: java.lang.Boolean
True when we are still preparing, false if we're rendering the final output.
scopeRequired
public IConstruct getScope();
- Type: software.constructs.IConstruct
The scope from which resolution has been initiated.
ignoreEscapesOptional
public java.lang.Boolean getIgnoreEscapes();
- Type: java.lang.Boolean
True when ${} should not be parsed, and treated as literals.
iteratorContextOptional
public java.lang.String getIteratorContext();
- Type: java.lang.String
TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
suppressBracesOptional
public java.lang.Boolean getSuppressBraces();
- Type: java.lang.Boolean
True when ${} should be ommitted (because already inside them), false otherwise.
warnEscapesOptional
public java.lang.Boolean getWarnEscapes();
- Type: java.lang.Boolean
True when ${} should not be included in the string to be resolved, outputs a warning.
Default: false
IResource
Properties
| Name | Type | Description |
|---|---|---|
node | software.constructs.Node | The tree node. |
stack | TerraformStack | The stack in which this resource is defined. |
nodeRequired
public Node getNode();
- Type: software.constructs.Node
The tree node.
stackRequired
public TerraformStack getStack();
- Type: TerraformStack
The stack in which this resource is defined.
IResourceConstructor
- Implemented By: IResourceConstructor
IScopeCallback
- Implemented By: IScopeCallback
IStackSynthesizer
- Implemented By: IStackSynthesizer
Encodes information how a certain Stack should be deployed inspired by AWS CDK v2 implementation (synth functionality was removed in constructs v10).
Methods
| Name | Description |
|---|---|
synthesize | Synthesize the associated stack to the session. |
synthesize
public void synthesize(ISynthesisSession session)
Synthesize the associated stack to the session.
sessionRequired
- Type: ISynthesisSession
IStringProducer
- Implemented By: IStringProducer
Interface for lazy string producers.
Methods
| Name | Description |
|---|---|
produce | Produce the string value. |
produce
public java.lang.String produce(IResolveContext context)
Produce the string value.
contextRequired
- Type: IResolveContext
ISynthesisSession
- Implemented By: ISynthesisSession
Represents a single session of synthesis.
Passed into TerraformStack.onSynthesize() methods.
originally from aws/constructs lib v3.3.126 (synth functionality was removed in constructs v10)
Properties
| Name | Type | Description |
|---|---|---|
manifest | Manifest | No description. |
outdir | java.lang.String | The output directory for this synthesis session. |
skipValidation | java.lang.Boolean | No description. |
manifestRequired
public Manifest getManifest();
- Type: Manifest
outdirRequired
public java.lang.String getOutdir();
- Type: java.lang.String
The output directory for this synthesis session.
skipValidationOptional
public java.lang.Boolean getSkipValidation();
- Type: java.lang.Boolean
ITerraformAddressable
- Implemented By: AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable
Properties
| Name | Type | Description |
|---|---|---|
fqn | java.lang.String | No description. |
fqnRequired
public java.lang.String getFqn();
- Type: java.lang.String
ITerraformDependable
Extends: ITerraformAddressable
Implemented By: DataResource, TerraformDataSource, TerraformHclModule, TerraformModule, TerraformResource, ITerraformDependable
Properties
| Name | Type | Description |
|---|---|---|
fqn | java.lang.String | No description. |
fqnRequired
public java.lang.String getFqn();
- Type: java.lang.String
ITerraformIterator
- Implemented By: DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator
ITerraformResource
- Implemented By: DataResource, TerraformDataSource, TerraformResource, ITerraformResource
Methods
| Name | Description |
|---|---|
interpolationForAttribute | No description. |
interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
- Type: java.lang.String
Properties
| Name | Type | Description |
|---|---|---|
fqn | java.lang.String | No description. |
friendlyUniqueId | java.lang.String | No description. |
terraformResourceType | java.lang.String | No description. |
count | java.lang.Number OR TerraformCount | No description. |
dependsOn | java.util.List< java.lang.String > | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
fqnRequired
public java.lang.String getFqn();
- Type: java.lang.String
friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
countOptional
public java.lang.Object getCount();
- Type: java.lang.Number OR TerraformCount
dependsOnOptional
public java.util.List< java.lang.String > getDependsOn();
- Type: java.util.List< java.lang.String >
forEachOptional
public ITerraformIterator getForEach();
- Type: ITerraformIterator
lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
providerOptional
public TerraformProvider getProvider();
- Type: TerraformProvider
ITokenMapper
- Implemented By: ITokenMapper
Interface to apply operation to tokens in a string.
Interface so it can be exported via jsii.
Methods
| Name | Description |
|---|---|
mapToken | Replace a single token. |
mapToken
public java.lang.Object mapToken(IResolvable t)
Replace a single token.
tRequired
- Type: IResolvable
ITokenResolver
- Implemented By: DefaultTokenResolver, ITokenResolver
How to resolve tokens.
Methods
| Name | Description |
|---|---|
resolveList | Resolve a tokenized list. |
resolveMap | Resolve a tokenized map. |
resolveNumberList | Resolve a tokenized number list. |
resolveString | Resolve a string with at least one stringified token in it. |
resolveToken | Resolve a single token. |
resolveList
public java.lang.Object resolveList(java.util.List< java.lang.String > l, IResolveContext context)
Resolve a tokenized list.
lRequired
- Type: java.util.List< java.lang.String >
contextRequired
- Type: IResolveContext
resolveMap
public java.lang.Object resolveMap(java.util.Map< java.lang.String, java.lang.Object > m, IResolveContext context)
Resolve a tokenized map.
mRequired
- Type: java.util.Map< java.lang.String, java.lang.Object >
contextRequired
- Type: IResolveContext
resolveNumberList
public java.lang.Object resolveNumberList(java.util.List< java.lang.Number > l, IResolveContext context)
Resolve a tokenized number list.
lRequired
- Type: java.util.List< java.lang.Number >
contextRequired
- Type: IResolveContext
resolveString
public java.lang.Object resolveString(TokenizedStringFragments s, IResolveContext context)
Resolve a string with at least one stringified token in it.
(May use concatenation)
sRequired
- Type: TokenizedStringFragments
contextRequired
- Type: IResolveContext
resolveToken
public java.lang.Object resolveToken(IResolvable t, IResolveContext context, IPostProcessor postProcessor)
Resolve a single token.
tRequired
- Type: IResolvable
contextRequired
- Type: IResolveContext
postProcessorRequired
- Type: IPostProcessor