|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "tlspc_firefly_policy Resource - tlspc" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +# tlspc_firefly_policy (Resource) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "tlspc_firefly_policy" "ff_policy" { |
| 17 | + name = "Firefly Policy 1" |
| 18 | + extended_key_usages = ["ANY"] |
| 19 | + key_usages = ["digitalSignature", "keyEncipherment"] |
| 20 | + validity_period = "P30D" |
| 21 | + key_algorithm = { |
| 22 | + allowed_values = ["RSA_2048"] |
| 23 | + default_value = "RSA_2048" |
| 24 | + } |
| 25 | + sans = { |
| 26 | + dns_names = { |
| 27 | + type = "OPTIONAL" |
| 28 | + min_occurrences = 0 |
| 29 | + max_occurrences = 1000 |
| 30 | + allowed_values = [] |
| 31 | + default_values = [] |
| 32 | + } |
| 33 | + ip_addresses = { |
| 34 | + type = "OPTIONAL" |
| 35 | + min_occurrences = 0 |
| 36 | + max_occurrences = 1000 |
| 37 | + allowed_values = [] |
| 38 | + default_values = [] |
| 39 | + } |
| 40 | + rfc822_names = { |
| 41 | + type = "OPTIONAL" |
| 42 | + min_occurrences = 0 |
| 43 | + max_occurrences = 1000 |
| 44 | + allowed_values = [] |
| 45 | + default_values = [] |
| 46 | + } |
| 47 | + uris = { |
| 48 | + type = "OPTIONAL" |
| 49 | + min_occurrences = 0 |
| 50 | + max_occurrences = 1000 |
| 51 | + allowed_values = [] |
| 52 | + default_values = [] |
| 53 | + } |
| 54 | + } |
| 55 | + subject = { |
| 56 | + country = { |
| 57 | + type = "OPTIONAL" |
| 58 | + min_occurrences = 0 |
| 59 | + max_occurrences = 1000 |
| 60 | + allowed_values = [] |
| 61 | + default_values = [] |
| 62 | + } |
| 63 | + common_name = { |
| 64 | + type = "OPTIONAL" |
| 65 | + min_occurrences = 0 |
| 66 | + max_occurrences = 1000 |
| 67 | + allowed_values = [] |
| 68 | + default_values = [] |
| 69 | + } |
| 70 | + locality = { |
| 71 | + type = "OPTIONAL" |
| 72 | + min_occurrences = 0 |
| 73 | + max_occurrences = 1000 |
| 74 | + allowed_values = [] |
| 75 | + default_values = [] |
| 76 | + } |
| 77 | + organization = { |
| 78 | + type = "OPTIONAL" |
| 79 | + min_occurrences = 0 |
| 80 | + max_occurrences = 1000 |
| 81 | + allowed_values = [] |
| 82 | + default_values = [] |
| 83 | + } |
| 84 | + organizational_unit = { |
| 85 | + type = "OPTIONAL" |
| 86 | + min_occurrences = 0 |
| 87 | + max_occurrences = 1000 |
| 88 | + allowed_values = [] |
| 89 | + default_values = [] |
| 90 | + } |
| 91 | + state_or_province = { |
| 92 | + type = "OPTIONAL" |
| 93 | + min_occurrences = 0 |
| 94 | + max_occurrences = 1000 |
| 95 | + allowed_values = [] |
| 96 | + default_values = [] |
| 97 | + } |
| 98 | + } |
| 99 | +} |
| 100 | +``` |
| 101 | + |
| 102 | +<!-- schema generated by tfplugindocs --> |
| 103 | +## Schema |
| 104 | + |
| 105 | +### Required |
| 106 | + |
| 107 | +- `extended_key_usages` (Set of String) List of Extended Key usages, valid options include: |
| 108 | + * ANY |
| 109 | + * SERVER_AUTH |
| 110 | + * CLIENT~_AUTH |
| 111 | + * CODE_SIGNING |
| 112 | + * EMAIL_PROTECTION |
| 113 | + * IPSEC_ENDSYSTEM |
| 114 | + * IPSEC_TUNNEL |
| 115 | + * IPSEC_USER |
| 116 | + * TIME_STAMPING |
| 117 | + * OCSP_SIGNING |
| 118 | + * DVCS |
| 119 | + * SBGP_CERT_AA_SERVER_AUTH |
| 120 | + * SCVP_RESPONDER |
| 121 | + * EAP_OVER_PPP |
| 122 | + * EAP_OVER_LAN |
| 123 | + * SCVP_SERVER |
| 124 | + * SCVP_CLIENT |
| 125 | + * IPSEC_IKE |
| 126 | + * CAPWAP_AC |
| 127 | + * CAPWAP_WTP |
| 128 | + * IPSEC_IKE_INTERMEDIATE |
| 129 | + * SMARTCARD_LOGON |
| 130 | +- `key_algorithm` (Attributes) (see [below for nested schema](#nestedatt--key_algorithm)) |
| 131 | +- `key_usages` (Set of String) List of Key usages, valid options include: |
| 132 | + * digitalSignature |
| 133 | + * nonRepudiation |
| 134 | + * keyEncipherment |
| 135 | + * dataEncipherment |
| 136 | + * keyAgreement |
| 137 | + * keyCertSign |
| 138 | + * cRLSign |
| 139 | + * encipherOnly |
| 140 | + * decipherOnly |
| 141 | +- `name` (String) The name of the Firefly Policy |
| 142 | +- `validity_period` (String) Validity Period in ISO8601 Period Format. e.g. P30D |
| 143 | + |
| 144 | +### Optional |
| 145 | + |
| 146 | +- `sans` (Attributes) Policy for Subject Alternative Names (see [below for nested schema](#nestedatt--sans)) |
| 147 | +- `subject` (Attributes) Policy for Subject (see [below for nested schema](#nestedatt--subject)) |
| 148 | + |
| 149 | +### Read-Only |
| 150 | + |
| 151 | +- `id` (String) The ID of this resource |
| 152 | + |
| 153 | +<a id="nestedatt--key_algorithm"></a> |
| 154 | +### Nested Schema for `key_algorithm` |
| 155 | + |
| 156 | +Required: |
| 157 | + |
| 158 | +- `allowed_values` (Set of String) A list of allowed Key Algorithm. Valid options include: |
| 159 | + * RSA_2048 |
| 160 | + * RSA_3072 |
| 161 | + * RSA_4096 |
| 162 | + * EC_P256 |
| 163 | + * EC_P384 |
| 164 | + * EC_P521 |
| 165 | + * EC_ED25519 |
| 166 | +- `default_value` (String) Default key algorithm |
| 167 | + |
| 168 | + |
| 169 | +<a id="nestedatt--sans"></a> |
| 170 | +### Nested Schema for `sans` |
| 171 | + |
| 172 | +Required: |
| 173 | + |
| 174 | +- `dns_names` (Attributes) (see [below for nested schema](#nestedatt--sans--dns_names)) |
| 175 | +- `ip_addresses` (Attributes) (see [below for nested schema](#nestedatt--sans--ip_addresses)) |
| 176 | +- `rfc822_names` (Attributes) (see [below for nested schema](#nestedatt--sans--rfc822_names)) |
| 177 | +- `uris` (Attributes) (see [below for nested schema](#nestedatt--sans--uris)) |
| 178 | + |
| 179 | +<a id="nestedatt--sans--dns_names"></a> |
| 180 | +### Nested Schema for `sans.dns_names` |
| 181 | + |
| 182 | +Required: |
| 183 | + |
| 184 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 185 | +- `max_occurrences` (Number) |
| 186 | +- `min_occurrences` (Number) |
| 187 | +- `type` (String) The type of this constraint, valid options include: |
| 188 | + * IGNORED |
| 189 | + * FORBIDDEN |
| 190 | + * OPTIONAL |
| 191 | + * REQUIRED |
| 192 | + |
| 193 | +Optional: |
| 194 | + |
| 195 | +- `default_values` (Set of String) A list of default values |
| 196 | + |
| 197 | + |
| 198 | +<a id="nestedatt--sans--ip_addresses"></a> |
| 199 | +### Nested Schema for `sans.ip_addresses` |
| 200 | + |
| 201 | +Required: |
| 202 | + |
| 203 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 204 | +- `max_occurrences` (Number) |
| 205 | +- `min_occurrences` (Number) |
| 206 | +- `type` (String) The type of this constraint, valid options include: |
| 207 | + * IGNORED |
| 208 | + * FORBIDDEN |
| 209 | + * OPTIONAL |
| 210 | + * REQUIRED |
| 211 | + |
| 212 | +Optional: |
| 213 | + |
| 214 | +- `default_values` (Set of String) A list of default values |
| 215 | + |
| 216 | + |
| 217 | +<a id="nestedatt--sans--rfc822_names"></a> |
| 218 | +### Nested Schema for `sans.rfc822_names` |
| 219 | + |
| 220 | +Required: |
| 221 | + |
| 222 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 223 | +- `max_occurrences` (Number) |
| 224 | +- `min_occurrences` (Number) |
| 225 | +- `type` (String) The type of this constraint, valid options include: |
| 226 | + * IGNORED |
| 227 | + * FORBIDDEN |
| 228 | + * OPTIONAL |
| 229 | + * REQUIRED |
| 230 | + |
| 231 | +Optional: |
| 232 | + |
| 233 | +- `default_values` (Set of String) A list of default values |
| 234 | + |
| 235 | + |
| 236 | +<a id="nestedatt--sans--uris"></a> |
| 237 | +### Nested Schema for `sans.uris` |
| 238 | + |
| 239 | +Required: |
| 240 | + |
| 241 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 242 | +- `max_occurrences` (Number) |
| 243 | +- `min_occurrences` (Number) |
| 244 | +- `type` (String) The type of this constraint, valid options include: |
| 245 | + * IGNORED |
| 246 | + * FORBIDDEN |
| 247 | + * OPTIONAL |
| 248 | + * REQUIRED |
| 249 | + |
| 250 | +Optional: |
| 251 | + |
| 252 | +- `default_values` (Set of String) A list of default values |
| 253 | + |
| 254 | + |
| 255 | + |
| 256 | +<a id="nestedatt--subject"></a> |
| 257 | +### Nested Schema for `subject` |
| 258 | + |
| 259 | +Required: |
| 260 | + |
| 261 | +- `common_name` (Attributes) (see [below for nested schema](#nestedatt--subject--common_name)) |
| 262 | +- `country` (Attributes) (see [below for nested schema](#nestedatt--subject--country)) |
| 263 | +- `locality` (Attributes) (see [below for nested schema](#nestedatt--subject--locality)) |
| 264 | +- `organization` (Attributes) (see [below for nested schema](#nestedatt--subject--organization)) |
| 265 | +- `organizational_unit` (Attributes) (see [below for nested schema](#nestedatt--subject--organizational_unit)) |
| 266 | +- `state_or_province` (Attributes) (see [below for nested schema](#nestedatt--subject--state_or_province)) |
| 267 | + |
| 268 | +<a id="nestedatt--subject--common_name"></a> |
| 269 | +### Nested Schema for `subject.common_name` |
| 270 | + |
| 271 | +Required: |
| 272 | + |
| 273 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 274 | +- `max_occurrences` (Number) |
| 275 | +- `min_occurrences` (Number) |
| 276 | +- `type` (String) The type of this constraint, valid options include: |
| 277 | + * IGNORED |
| 278 | + * FORBIDDEN |
| 279 | + * OPTIONAL |
| 280 | + * REQUIRED |
| 281 | + |
| 282 | +Optional: |
| 283 | + |
| 284 | +- `default_values` (Set of String) A list of default values |
| 285 | + |
| 286 | + |
| 287 | +<a id="nestedatt--subject--country"></a> |
| 288 | +### Nested Schema for `subject.country` |
| 289 | + |
| 290 | +Required: |
| 291 | + |
| 292 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 293 | +- `max_occurrences` (Number) |
| 294 | +- `min_occurrences` (Number) |
| 295 | +- `type` (String) The type of this constraint, valid options include: |
| 296 | + * IGNORED |
| 297 | + * FORBIDDEN |
| 298 | + * OPTIONAL |
| 299 | + * REQUIRED |
| 300 | + |
| 301 | +Optional: |
| 302 | + |
| 303 | +- `default_values` (Set of String) A list of default values |
| 304 | + |
| 305 | + |
| 306 | +<a id="nestedatt--subject--locality"></a> |
| 307 | +### Nested Schema for `subject.locality` |
| 308 | + |
| 309 | +Required: |
| 310 | + |
| 311 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 312 | +- `max_occurrences` (Number) |
| 313 | +- `min_occurrences` (Number) |
| 314 | +- `type` (String) The type of this constraint, valid options include: |
| 315 | + * IGNORED |
| 316 | + * FORBIDDEN |
| 317 | + * OPTIONAL |
| 318 | + * REQUIRED |
| 319 | + |
| 320 | +Optional: |
| 321 | + |
| 322 | +- `default_values` (Set of String) A list of default values |
| 323 | + |
| 324 | + |
| 325 | +<a id="nestedatt--subject--organization"></a> |
| 326 | +### Nested Schema for `subject.organization` |
| 327 | + |
| 328 | +Required: |
| 329 | + |
| 330 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 331 | +- `max_occurrences` (Number) |
| 332 | +- `min_occurrences` (Number) |
| 333 | +- `type` (String) The type of this constraint, valid options include: |
| 334 | + * IGNORED |
| 335 | + * FORBIDDEN |
| 336 | + * OPTIONAL |
| 337 | + * REQUIRED |
| 338 | + |
| 339 | +Optional: |
| 340 | + |
| 341 | +- `default_values` (Set of String) A list of default values |
| 342 | + |
| 343 | + |
| 344 | +<a id="nestedatt--subject--organizational_unit"></a> |
| 345 | +### Nested Schema for `subject.organizational_unit` |
| 346 | + |
| 347 | +Required: |
| 348 | + |
| 349 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 350 | +- `max_occurrences` (Number) |
| 351 | +- `min_occurrences` (Number) |
| 352 | +- `type` (String) The type of this constraint, valid options include: |
| 353 | + * IGNORED |
| 354 | + * FORBIDDEN |
| 355 | + * OPTIONAL |
| 356 | + * REQUIRED |
| 357 | + |
| 358 | +Optional: |
| 359 | + |
| 360 | +- `default_values` (Set of String) A list of default values |
| 361 | + |
| 362 | + |
| 363 | +<a id="nestedatt--subject--state_or_province"></a> |
| 364 | +### Nested Schema for `subject.state_or_province` |
| 365 | + |
| 366 | +Required: |
| 367 | + |
| 368 | +- `allowed_values` (Set of String) A list of allowed values, may be literal strings or regular expressions. Regular expressions must be prefixed with '^' |
| 369 | +- `max_occurrences` (Number) |
| 370 | +- `min_occurrences` (Number) |
| 371 | +- `type` (String) The type of this constraint, valid options include: |
| 372 | + * IGNORED |
| 373 | + * FORBIDDEN |
| 374 | + * OPTIONAL |
| 375 | + * REQUIRED |
| 376 | + |
| 377 | +Optional: |
| 378 | + |
| 379 | +- `default_values` (Set of String) A list of default values |
0 commit comments