validasi

Memvalidasi data terhadap AWS CloudFormation Guard aturan untuk menentukan keberhasilan atau kegagalan.

Sintaks

cfn-guard validate
--data <value>
--output-format <value>
--rules <value>
--show-summary <value>
--type <value>

Parameter

-a, --alphabetical

Memvalidasi file dalam direktori yang diurutkan menurut abjad.

-h, --help

Mencetak informasi bantuan.

-m, --last-modified

Memvalidasi file dalam direktori yang diurutkan berdasarkan waktu modifikasi terakhir.

-P, --payload

Memungkinkan Anda memberikan aturan dan data dalam JSON format berikut melaluistdin:

{"rules":["<rules 1>", "<rules 2>", ...], "data":["<data 1>", "<data 2>", ...]}

Sebagai contoh:

{"data": ["{\"Resources\":{\"NewVolume\":{\"Type\":\"AWS::EC2::Volume\",\"Properties\":{\"Size\":500,\"Encrypted\":false,\"AvailabilityZone\":\"us-west-2b\"}},\"NewVolume2\":{\"Type\":\"AWS::EC2::Volume\",\"Properties\":{\"Size\":50,\"Encrypted\":false,\"AvailabilityZone\":\"us-west-2c\"}}},\"Parameters\":{\"InstanceName\":\"TestInstance\"}}","{\"Resources\":{\"NewVolume\":{\"Type\":\"AWS::EC2::Volume\",\"Properties\":{\"Size\":500,\"Encrypted\":false,\"AvailabilityZone\":\"us-west-2b\"}},\"NewVolume2\":{\"Type\":\"AWS::EC2::Volume\",\"Properties\":{\"Size\":50,\"Encrypted\":false,\"AvailabilityZone\":\"us-west-2c\"}}},\"Parameters\":{\"InstanceName\":\"TestInstance\"}}"], "rules" : [ "Parameters.InstanceName == \"TestInstance\"","Parameters.InstanceName == \"TestInstance\"" ]}

Untuk “aturan”, tentukan daftar string file aturan. Untuk “data”, tentukan daftar string file data.

Jika Anda menentukan --payload bendera, jangan tentukan --data opsi --rules atau.

-p, --print-json

Mencetak output dalam JSON format.

-s, --show-clause-failures

Menunjukkan kegagalan klausa termasuk ringkasan.

-V, --version

Mencetak informasi versi.

-v, --verbose

Meningkatkan verbositas output. Dapat ditentukan beberapa kali.

Opsi

-d, --data (string)

Menyediakan nama file atau direktori untuk file data dalam salah satu JSON atau YAML format. Jika Anda menyediakan direktori, Guard mengevaluasi aturan yang ditentukan terhadap semua file data dalam direktori. Direktori harus berisi hanya file data; tidak dapat berisi file data dan aturan.

Jika Anda menentukan --payload bendera, jangan tentukan --data opsi.

-o, --output-format (string)

Menulis ke file output.

Default: single-line-summary

Nilai yang diizinkan: json | yaml | single-line-summary

-r, --rules (string)

Menyediakan nama file aturan atau direktori file aturan. Jika Anda menyediakan direktori, Guard mengevaluasi semua aturan dalam direktori terhadap data yang ditentukan. Direktori harus berisi hanya file aturan; tidak dapat berisi file data dan aturan.

Jika Anda menentukan --payload bendera, jangan tentukan --rules opsi.

--show-summary(tali)

Menentukan verbositas ringkasan evaluasi aturan Guard. Jika Anda menentukanall, Guard menampilkan ringkasan lengkap. Jika Anda menentukanpass,fail, Guard hanya menampilkan informasi ringkasan untuk aturan yang diteruskan atau gagal. Jika Anda menentukannone, Guard tidak menampilkan informasi ringkasan. Secara default, all ditentukan.

Nilai yang diizinkan: all | pass,fail | none

-t, --type (string)

Menyediakan format data input Anda. Saat Anda menentukan tipe data input, Guard menampilkan nama logis sumber daya CloudFormation template dalam output. Secara default, Guard menampilkan jalur dan nilai properti, sepertiProperty [/Resources/vol2/Properties/Encrypted.

Nilai yang diizinkan: CFNTemplate

Contoh

cfn-guard validate \
--data file_directory_name \
--output-format yaml \
--rules rules.guard \
--show-summary pass,fail \
--type CFNtemplate

Output

Jika Guard berhasil memvalidasi template, validate perintah mengembalikan status keluar 0 ($?dalam bash). Jika Guard mengidentifikasi pelanggaran aturan, validate perintah mengembalikan laporan status aturan yang gagal. Gunakan bendera verbose (-v) untuk melihat pohon evaluasi terperinci yang menunjukkan bagaimana Guard mengevaluasi setiap aturan.

Summary Report Overall File Status = PASS
PASS/SKIP rules
default PASS

Lihat juga

Memvalidasi data input terhadap aturan Guard