Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,11 @@ Construct an engine and a schema validator once, then validate many templates:

```rust
use cloudformation_validate::{
EngineConfig, RegoEngine, SchemaValidator, ValidateConfig, validate_bytes_with_path,
CompositeEngine, CompositeEngineConfig, SchemaValidator, ValidateConfig, validate_bytes_with_path,
};

let schema_validator = SchemaValidator::default();
let engine = RegoEngine::new(EngineConfig::default())?;
let engine = CompositeEngine::new(CompositeEngineConfig::default())?;

let bytes = std::fs::read("template.yaml")?;
let report = validate_bytes_with_path(
Expand Down Expand Up @@ -179,9 +179,9 @@ the content in `TemplateContent`, Python accepts `bytes` or a `TemplateContent`,
### Node.js [(bindings-wasm)](src/bindings-wasm/README.md)

```typescript
import {RegoEngine, TemplateFile} from "@aws/cloudformation-validate";
import {CompositeEngine, TemplateFile} from "@aws/cloudformation-validate";

const engine = new RegoEngine();
const engine = new CompositeEngine();
const report = engine.validateTemplate(new TemplateFile("template.yaml"));
for (const d of report.diagnostics) {
console.log(`[${d.severity}] ${d.ruleId}: ${d.message}`);
Expand All @@ -192,9 +192,9 @@ engine.free();
### Python [(bindings-python)](src/bindings-python/README.md)

```python
from cloudformation_validate import RegoEngine
from cloudformation_validate import CompositeEngine

engine = RegoEngine()
engine = CompositeEngine()
report = engine.validate_template("template.yaml")
for d in report.diagnostics:
print(f"[{d.severity.name}] {d.rule_id}: {d.message}")
Expand All @@ -205,7 +205,7 @@ for d in report.diagnostics:
```go
import cfnvalidate "github.com/aws-cloudformation/cloudformation-validate/src/bindings-go/go"

engine, err := cfnvalidate.NewRegoEngine(nil)
engine, err := cfnvalidate.NewCompositeEngine(nil)
if err != nil {
log.Fatal(err)
}
Expand All @@ -223,7 +223,7 @@ for _, d := range report.Diagnostics {
import software.amazon.cloudformation.validate.*
import java.io.File

val engine = RegoEngine()
val engine = CompositeEngine()
val report = engine.validateTemplate(File("template.yaml"))
for (d in report.diagnostics) {
println("[${d.severity}] ${d.ruleId}: ${d.message}")
Expand Down
2 changes: 1 addition & 1 deletion src/bindings-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ MSVC.
Engines, models, and validators hold off-heap memory - call `Destroy()` when done with each object:

```go
engine, err := cfnvalidate.NewRegoEngine(nil)
engine, err := cfnvalidate.NewCompositeEngine(nil)
if err != nil {
log.Fatal(err)
}
Expand Down
8 changes: 4 additions & 4 deletions src/bindings-jvm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ library).
## Quick start

```kotlin
import software.amazon.cloudformation.validate.RegoEngine
import software.amazon.cloudformation.validate.CompositeEngine
import java.io.File

val engine = RegoEngine()
val engine = CompositeEngine()
val report = engine.validateTemplate(File("template.yaml"))
for (d in report.diagnostics) {
println("[${d.severity}] ${d.ruleId}: ${d.message}")
Expand Down Expand Up @@ -352,10 +352,10 @@ constraint the API itself does not enforce - is skipped with a reason, never gue

```kotlin
import software.amazon.cloudformation.validate.AwsCliCommand
import software.amazon.cloudformation.validate.RegoEngine
import software.amazon.cloudformation.validate.CompositeEngine
import software.amazon.cloudformation.validate.engine.AwsCliCommandValidationStatus

val engine = RegoEngine()
val engine = CompositeEngine()
val request = AwsCliCommand("s3", "CreateBucket", mapOf("Bucket" to "example-bucket"))
val validation = engine.validateAwsCliCommand(request)
if (validation.status == AwsCliCommandValidationStatus.VALIDATED) {
Expand Down
8 changes: 4 additions & 4 deletions src/bindings-python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ only the artifact compatible with the installing host.
## Quick start

```python
from cloudformation_validate import RegoEngine
from cloudformation_validate import CompositeEngine

engine = RegoEngine()
engine = CompositeEngine()
report = engine.validate_template("template.yaml")
for d in report.diagnostics:
print(f"[{d.severity.name}] {d.rule_id}: {d.message}")
Expand Down Expand Up @@ -329,9 +329,9 @@ exactly - an unregistered operation, a parameter without a lossless property map
CloudFormation constraint the API itself does not enforce - is skipped with a reason, never guessed.

```python
from cloudformation_validate import AwsCliCommand, AwsCliCommandValidationStatus, RegoEngine
from cloudformation_validate import AwsCliCommand, AwsCliCommandValidationStatus, CompositeEngine

engine = RegoEngine()
engine = CompositeEngine()
request = AwsCliCommand("s3", "CreateBucket", {"Bucket": "example-bucket"})
validation = engine.validate_aws_cli_command(request)
if validation.status == AwsCliCommandValidationStatus.VALIDATED:
Expand Down
14 changes: 8 additions & 6 deletions src/bindings-rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ Requires Rust 1.96 or later (the repository pins that toolchain in [`rust-toolch
## Quick start

```rust
use cloudformation_validate::{EngineConfig, RegoEngine, SchemaValidator, ValidateConfig, validate_bytes_with_path};
use cloudformation_validate::{
CompositeEngine, CompositeEngineConfig, SchemaValidator, ValidateConfig, validate_bytes_with_path,
};

let schema_validator = SchemaValidator::default();
let engine = RegoEngine::new(EngineConfig::default())?;
let engine = CompositeEngine::new(CompositeEngineConfig::default())?;

let template = std::fs::read("template.yaml").unwrap_or_else(|_| b"Resources: {}\n".to_vec());
let report = validate_bytes_with_path(
Expand Down Expand Up @@ -231,11 +233,11 @@ defaults - `ValidateConfig::default()` uses them.

```rust,no_run
use cloudformation_validate::{
EngineConfig, FilterConfig, RegoEngine, RuleFilterConfig, SchemaValidator, Severity, ValidateConfig,
CompositeEngine, CompositeEngineConfig, FilterConfig, RuleFilterConfig, SchemaValidator, Severity, ValidateConfig,
validate_bytes_with_path,
};

let engine = RegoEngine::new(EngineConfig::default())?;
let engine = CompositeEngine::new(CompositeEngineConfig::default())?;
let schema_validator = SchemaValidator::default();
let template = std::fs::read("template.yaml")?;
let report = validate_bytes_with_path(
Expand Down Expand Up @@ -391,9 +393,9 @@ result types live in the `validation_engine` module.
use cloudformation_validate::validation_engine::{
AwsCliCommand, AwsCliCommandValidationStatus, AwsCliValue, validate_aws_cli_command,
};
use cloudformation_validate::{EngineConfig, RegoEngine, SchemaValidator};
use cloudformation_validate::{CompositeEngine, CompositeEngineConfig, SchemaValidator};

let engine = RegoEngine::new(EngineConfig::default())?;
let engine = CompositeEngine::new(CompositeEngineConfig::default())?;
let schema_validator = SchemaValidator::default();
let request = AwsCliCommand::new(
"s3",
Expand Down
8 changes: 4 additions & 4 deletions src/bindings-wasm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Requires Node.js 20 or later. The package has no runtime dependencies.
Engines, models, and validators hold off-heap memory - call `.free()` when done with each object:

```typescript
import { RegoEngine, TemplateFile } from "@aws/cloudformation-validate";
import { CompositeEngine, TemplateFile } from "@aws/cloudformation-validate";

const engine = new RegoEngine();
const engine = new CompositeEngine();
try {
const report = engine.validateTemplate(new TemplateFile("template.yaml"));
for (const d of report.diagnostics) {
Expand Down Expand Up @@ -346,9 +346,9 @@ an unregistered operation, a parameter without a lossless property mapping, or a
constraint the API itself does not enforce - is skipped with a reason, never guessed.

```typescript
import { AwsCliCommand, RegoEngine } from "@aws/cloudformation-validate";
import { AwsCliCommand, CompositeEngine } from "@aws/cloudformation-validate";

const engine = new RegoEngine();
const engine = new CompositeEngine();
try {
const request = new AwsCliCommand("s3", "CreateBucket", { Bucket: "example-bucket" });
const validation = engine.validateAwsCliCommand(request);
Expand Down
Loading