/
schema.json
3302 lines (3302 loc) · 260 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"name": "awsx",
"displayName": "AWSx (Pulumi Crosswalk for AWS)",
"description": "Pulumi Amazon Web Services (AWS) AWSX Components.",
"keywords": [
"pulumi",
"aws",
"awsx",
"kind/component",
"category/cloud"
],
"homepage": "https://pulumi.com",
"license": "Apache-2.0",
"repository": "https://github.com/pulumi/pulumi-awsx",
"publisher": "Pulumi",
"language": {
"csharp": {
"liftSingleValueMethodReturns": true,
"packageReferences": {
"Pulumi": "3.*",
"Pulumi.Aws": "6.*",
"Pulumi.Docker": "4.*"
}
},
"go": {
"generateResourceContainerTypes": true,
"importBasePath": "github.com/pulumi/pulumi-awsx/sdk/v2/go/awsx",
"internalDependencies": [
"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
],
"liftSingleValueMethodReturns": true
},
"java": {
"dependencies": {
"com.pulumi:aws": "6.32.0",
"com.pulumi:docker": "4.5.1"
}
},
"nodejs": {
"dependencies": {
"@aws-sdk/client-ecs": "^3.405.0",
"@pulumi/aws": "^6.32.0",
"@pulumi/docker": "^4.5.1",
"@pulumi/pulumi": "^3.0.0",
"@types/aws-lambda": "^8.10.23",
"aws-sdk": "^2.1450.0",
"docker-classic": "npm:@pulumi/docker@3.6.1",
"mime": "^2.0.0"
},
"devDependencies": {
"@types/mime": "^2.0.0",
"@types/node": "^18",
"typescript": "^4.6.2"
}
},
"python": {
"liftSingleValueMethodReturns": true,
"pyproject": {
"enabled": true
},
"readme": "Pulumi Amazon Web Services (AWS) AWSX Components.",
"requires": {
"pulumi": "\u003e=3.91.1,\u003c4.0.0",
"pulumi-aws": "\u003e=6.0.4,\u003c7.0.0",
"pulumi-docker": "\u003e=4.5.1,\u003c5.0.0"
},
"usesIOClasses": true
}
},
"config": {},
"types": {
"awsx:awsx:Bucket": {
"description": "The set of arguments for constructing a Bucket resource.",
"properties": {
"accelerationStatus": {
"type": "string",
"description": "Sets the accelerate configuration of an existing bucket. Can be `Enabled` or `Suspended`.\n"
},
"acl": {
"type": "string",
"description": "The [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, and `log-delivery-write`. Defaults to `private`. Conflicts with `grant`.\n"
},
"arn": {
"type": "string",
"description": "The ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`.\n"
},
"bucket": {
"type": "string",
"description": "The name of the bucket. If omitted, this provider will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n",
"language": {
"csharp": {
"name": "BucketName"
}
},
"willReplaceOnChanges": true
},
"bucketPrefix": {
"type": "string",
"description": "Creates a unique bucket name beginning with the specified prefix. Conflicts with `bucket`. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n",
"willReplaceOnChanges": true
},
"corsRules": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketCorsRule:BucketCorsRule"
},
"description": "A rule of [Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) (documented below).\n"
},
"forceDestroy": {
"type": "boolean",
"description": "A boolean that indicates all objects (including any [locked objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)) should be deleted from the bucket so that the bucket can be destroyed without error. These objects are *not* recoverable.\n"
},
"grants": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketGrant:BucketGrant"
},
"description": "An [ACL policy grant](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#sample-acl) (documented below). Conflicts with `acl`.\n"
},
"hostedZoneId": {
"type": "string",
"description": "The [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region.\n"
},
"lifecycleRules": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketLifecycleRule:BucketLifecycleRule"
},
"description": "A configuration of [object lifecycle management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) (documented below).\n"
},
"loggings": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketLogging:BucketLogging"
},
"description": "A settings of [bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/UG/ManagingBucketLogging.html) (documented below).\n"
},
"objectLockConfiguration": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketObjectLockConfiguration:BucketObjectLockConfiguration",
"description": "A configuration of [S3 object locking](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) (documented below)\n\n\u003e **NOTE:** You cannot use `acceleration_status` in `cn-north-1` or `us-gov-west-1`\n"
},
"policy": {
"type": "string",
"description": "A valid [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) JSON document. Note that if the policy document is not specific enough (but still valid), this provider may view the policy as constantly changing in a `pulumi preview`. In this case, please make sure you use the verbose/specific version of the policy.\n"
},
"replicationConfiguration": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketReplicationConfiguration:BucketReplicationConfiguration",
"description": "A configuration of [replication configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html) (documented below).\n"
},
"requestPayer": {
"type": "string",
"description": "Specifies who should bear the cost of Amazon S3 data transfer.\nCan be either `BucketOwner` or `Requester`. By default, the owner of the S3 bucket would incur\nthe costs of any data transfer. See [Requester Pays Buckets](http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)\ndeveloper guide for more information.\n"
},
"serverSideEncryptionConfiguration": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketServerSideEncryptionConfiguration:BucketServerSideEncryptionConfiguration",
"description": "A configuration of [server-side encryption configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) (documented below)\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of tags to assign to the bucket. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
},
"versioning": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketVersioning:BucketVersioning",
"description": "A state of [versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) (documented below)\n"
},
"website": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:s3/BucketWebsite:BucketWebsite",
"description": "A website object (documented below).\n"
},
"websiteDomain": {
"type": "string",
"description": "The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records.\n"
},
"websiteEndpoint": {
"type": "string",
"description": "The website endpoint, if the bucket is configured with a website. If not, this will be an empty string.\n"
}
},
"type": "object"
},
"awsx:awsx:DefaultBucket": {
"description": "Bucket with default setup unless explicitly skipped.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:Bucket",
"plain": true,
"description": "Arguments to use instead of the default values during creation."
},
"existing": {
"$ref": "#/types/awsx:awsx:ExistingBucket",
"plain": true,
"description": "Identity of an existing bucket to use. Cannot be used in combination with `args`."
},
"skip": {
"type": "boolean",
"plain": true,
"description": "Skip creation of the bucket."
}
},
"type": "object"
},
"awsx:awsx:DefaultLogGroup": {
"description": "Log group with default setup unless explicitly skipped.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:LogGroup",
"plain": true,
"description": "Arguments to use instead of the default values during creation."
},
"existing": {
"$ref": "#/types/awsx:awsx:ExistingLogGroup",
"plain": true,
"description": "Identity of an existing log group to use. Cannot be used in combination with `args` or `opts`."
},
"skip": {
"type": "boolean",
"plain": true,
"description": "Skip creation of the log group."
}
},
"type": "object"
},
"awsx:awsx:DefaultRoleWithPolicy": {
"description": "Role and policy attachments with default setup unless explicitly skipped or an existing role ARN provided.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:RoleWithPolicy",
"plain": true,
"description": "Args to use when creating the role and policies. Can't be specified if `roleArn` is used."
},
"roleArn": {
"type": "string",
"description": "ARN of existing role to use instead of creating a new role. Cannot be used in combination with `args` or `opts`."
},
"skip": {
"type": "boolean",
"plain": true,
"description": "Skips creation of the role if set to `true`."
}
},
"type": "object"
},
"awsx:awsx:DefaultSecurityGroup": {
"description": "Security Group with default setup unless explicitly skipped or an existing security group id provided.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:SecurityGroup",
"plain": true,
"description": "Args to use when creating the security group. Can't be specified if `securityGroupId` is used."
},
"securityGroupId": {
"type": "string",
"description": "Id of existing security group to use instead of creating a new security group. Cannot be used in combination with `args` or `opts`."
},
"skip": {
"type": "boolean",
"plain": true,
"description": "Skips creation of the security group if set to `true`."
}
},
"type": "object"
},
"awsx:awsx:ExistingBucket": {
"description": "Reference to an existing bucket.",
"properties": {
"arn": {
"type": "string",
"description": "Arn of the bucket. Only one of [arn] or [name] can be specified."
},
"name": {
"type": "string",
"description": "Name of the bucket. Only one of [arn] or [name] can be specified."
}
},
"type": "object"
},
"awsx:awsx:ExistingLogGroup": {
"description": "Reference to an existing log group.",
"properties": {
"arn": {
"type": "string",
"description": "Arn of the log group. Only one of [arn] or [name] can be specified."
},
"name": {
"type": "string",
"description": "Name of the log group. Only one of [arn] or [name] can be specified."
},
"region": {
"type": "string",
"description": "Region of the log group. If not specified, the provider region will be used."
}
},
"type": "object"
},
"awsx:awsx:LogGroup": {
"description": "The set of arguments for constructing a LogGroup resource.",
"properties": {
"kmsKeyId": {
"type": "string",
"description": "The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group,\nAWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires\npermissions for the CMK whenever the encrypted data is requested.\n"
},
"logGroupClass": {
"type": "string",
"description": "Specified the log class of the log group. Possible values are: `STANDARD` or `INFREQUENT_ACCESS`.\n",
"willReplaceOnChanges": true
},
"name": {
"type": "string",
"description": "The name of the log group. If omitted, this provider will assign a random, unique name.\n",
"willReplaceOnChanges": true
},
"namePrefix": {
"type": "string",
"description": "Creates a unique name beginning with the specified prefix. Conflicts with `name`.\n",
"willReplaceOnChanges": true
},
"retentionInDays": {
"type": "integer",
"description": "Specifies the number of days\nyou want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0.\nIf you select 0, the events in the log group are always retained and never expire.\n"
},
"skipDestroy": {
"type": "boolean",
"description": "Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the state.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of tags to assign to the resource. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
}
},
"type": "object"
},
"awsx:awsx:OptionalLogGroup": {
"description": "Log group which is only created if enabled.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:LogGroup",
"plain": true,
"description": "Arguments to use instead of the default values during creation."
},
"enable": {
"type": "boolean",
"plain": true,
"description": "Enable creation of the log group."
},
"existing": {
"$ref": "#/types/awsx:awsx:ExistingLogGroup",
"plain": true,
"description": "Identity of an existing log group to use. Cannot be used in combination with `args` or `opts`."
}
},
"type": "object"
},
"awsx:awsx:RequiredBucket": {
"description": "Bucket with default setup.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:Bucket",
"plain": true,
"description": "Arguments to use instead of the default values during creation."
},
"existing": {
"$ref": "#/types/awsx:awsx:ExistingBucket",
"plain": true,
"description": "Identity of an existing bucket to use. Cannot be used in combination with `args`."
}
},
"type": "object"
},
"awsx:awsx:RequiredLogGroup": {
"description": "Log group with default setup.",
"properties": {
"args": {
"$ref": "#/types/awsx:awsx:LogGroup",
"plain": true,
"description": "Arguments to use instead of the default values during creation."
},
"existing": {
"$ref": "#/types/awsx:awsx:ExistingLogGroup",
"plain": true,
"description": "Identity of an existing log group to use. Cannot be used in combination with `args` or `opts`."
}
},
"type": "object"
},
"awsx:awsx:RoleWithPolicy": {
"description": "The set of arguments for constructing a Role resource and Policy attachments.",
"properties": {
"description": {
"type": "string",
"description": "Description of the role.\n"
},
"forceDetachPolicies": {
"type": "boolean",
"description": "Whether to force detaching any policies the role has before destroying it. Defaults to `false`.\n"
},
"inlinePolicies": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:iam/RoleInlinePolicy:RoleInlinePolicy"
},
"description": "Configuration block defining an exclusive set of IAM inline policies associated with the IAM role. See below. If no blocks are configured, the provider will not manage any inline policies in this resource. Configuring one empty block (i.e., `inline_policy {}`) will cause the provider to remove _all_ inline policies added out of band on `apply`.\n"
},
"managedPolicyArns": {
"type": "array",
"items": {
"type": "string"
}
},
"maxSessionDuration": {
"type": "integer",
"description": "Maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.\n"
},
"name": {
"type": "string",
"description": "Friendly name of the role. If omitted, the provider will assign a random, unique name. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.\n",
"willReplaceOnChanges": true
},
"namePrefix": {
"type": "string",
"description": "Creates a unique friendly name beginning with the specified prefix. Conflicts with `name`.\n",
"willReplaceOnChanges": true
},
"path": {
"type": "string",
"description": "Path to the role. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.\n",
"willReplaceOnChanges": true
},
"permissionsBoundary": {
"type": "string",
"description": "ARN of the policy that is used to set the permissions boundary for the role.\n"
},
"policyArns": {
"type": "array",
"items": {
"type": "string",
"plain": true
},
"plain": true,
"description": "ARNs of the policies to attach to the created role."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Key-value mapping of tags for the IAM role. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
}
},
"type": "object"
},
"awsx:awsx:SecurityGroup": {
"description": "The set of arguments for constructing a Security Group resource.",
"properties": {
"description": {
"type": "string",
"description": "Security group description. Defaults to `Managed by Pulumi`. Cannot be `\"\"`. **NOTE**: This field maps to the AWS `GroupDescription` attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, use `tags`.\n",
"default": "Managed by Pulumi",
"willReplaceOnChanges": true
},
"egress": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ec2/SecurityGroupEgress:SecurityGroupEgress"
},
"description": "Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.\n"
},
"ingress": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ec2/SecurityGroupIngress:SecurityGroupIngress"
},
"description": "Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.\n"
},
"name": {
"type": "string",
"description": "Name of the security group. If omitted, the provider will assign a random, unique name.\n",
"willReplaceOnChanges": true
},
"namePrefix": {
"type": "string",
"description": "Creates a unique name beginning with the specified prefix. Conflicts with `name`.\n",
"willReplaceOnChanges": true
},
"revokeRulesOnDelete": {
"type": "boolean",
"description": "Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default `false`.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
},
"vpcId": {
"type": "string",
"description": "VPC ID. Defaults to the region's default VPC.\n",
"willReplaceOnChanges": true
}
},
"type": "object"
},
"awsx:cloudtrail:LogGroup": {
"description": "Defines the log group configuration for the CloudWatch Log Group to send logs to.",
"properties": {
"kmsKeyId": {
"type": "string",
"description": "The ARN of the KMS Key to use when encrypting log data."
},
"namePrefix": {
"type": "string",
"description": "Creates a unique name beginning with the specified prefix"
},
"retentionInDays": {
"type": "integer",
"description": "Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the log group are always retained and never expire."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of tags to assign to the resource. If configured with provider defaultTags present, tags with matching keys will overwrite those defined at the provider-level."
}
},
"type": "object"
},
"awsx:ec2:NatGatewayConfiguration": {
"description": "Configuration for NAT Gateways.",
"properties": {
"elasticIpAllocationIds": {
"type": "array",
"items": {
"type": "string"
},
"plain": true,
"description": "A list of EIP allocation IDs to assign to the NAT Gateways. Optional. If specified, the number of supplied values must match the chosen strategy (either one, or the number of availability zones)."
},
"strategy": {
"$ref": "#/types/awsx:ec2:NatGatewayStrategy",
"plain": true,
"description": "The strategy for deploying NAT Gateways."
}
},
"type": "object",
"required": [
"strategy"
]
},
"awsx:ec2:NatGatewayStrategy": {
"description": "A strategy for creating NAT Gateways for private subnets within a VPC.",
"type": "string",
"enum": [
{
"description": "Do not create any NAT Gateways. Resources in private subnets will not be able to access the internet.",
"value": "None"
},
{
"description": "Create a single NAT Gateway for the entire VPC. This configuration is not recommended for production infrastructure as it creates a single point of failure.",
"value": "Single"
},
{
"description": "Create a NAT Gateway in each availability zone. This is the recommended configuration for production infrastructure.",
"value": "OnePerAz"
}
]
},
"awsx:ec2:ResolvedSubnetSpec": {
"description": "Configuration for a VPC subnet spec.",
"properties": {
"cidrBlocks": {
"type": "array",
"items": {
"type": "string",
"plain": true
},
"plain": true,
"description": "An optional list of CIDR blocks to assign to the subnet spec for each AZ. If specified, the count must match the number of AZs being used for the VPC, and must also be specified for all other subnet specs."
},
"cidrMask": {
"type": "integer",
"plain": true,
"description": "The netmask for the subnet's CIDR block. This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone."
},
"name": {
"type": "string",
"plain": true,
"description": "The subnet's name. Will be templated upon creation."
},
"size": {
"type": "integer",
"plain": true,
"description": "Optional size of the subnet's CIDR block - the number of hosts. This value must be a power of 2 (e.g. 256, 512, 1024, etc.). This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone."
},
"type": {
"$ref": "#/types/awsx:ec2:SubnetType",
"plain": true,
"description": "The type of subnet."
}
},
"type": "object",
"required": [
"type"
]
},
"awsx:ec2:SubnetAllocationStrategy": {
"description": "Strategy for calculating subnet ranges from the subnet specifications.",
"type": "string",
"enum": [
{
"description": "Group private subnets first, followed by public subnets, followed by isolated subnets.",
"value": "Legacy"
},
{
"description": "Order remains as specified by specs, allowing gaps where required.",
"value": "Auto"
},
{
"description": "Whole range of VPC must be accounted for, using \"Unused\" spec types for deliberate gaps.",
"value": "Exact"
}
]
},
"awsx:ec2:SubnetSpec": {
"description": "Configuration for a VPC subnet.",
"properties": {
"cidrBlocks": {
"type": "array",
"items": {
"type": "string",
"plain": true
},
"plain": true,
"description": "An optional list of CIDR blocks to assign to the subnet spec for each AZ. If specified, the count must match the number of AZs being used for the VPC, and must also be specified for all other subnet specs."
},
"cidrMask": {
"type": "integer",
"plain": true,
"description": "The netmask for the subnet's CIDR block. This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone."
},
"name": {
"type": "string",
"plain": true,
"description": "The subnet's name. Will be templated upon creation."
},
"size": {
"type": "integer",
"plain": true,
"description": "Optional size of the subnet's CIDR block - the number of hosts. This value must be a power of 2 (e.g. 256, 512, 1024, etc.). This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of tags to assign to the resource."
},
"type": {
"$ref": "#/types/awsx:ec2:SubnetType",
"plain": true,
"description": "The type of subnet."
}
},
"type": "object",
"required": [
"type"
]
},
"awsx:ec2:SubnetType": {
"description": "A type of subnet within a VPC.",
"type": "string",
"enum": [
{
"description": "A subnet whose hosts can directly communicate with the internet.",
"value": "Public"
},
{
"description": "A subnet whose hosts can not directly communicate with the internet, but can initiate outbound network traffic via a NAT Gateway.",
"value": "Private"
},
{
"description": "A subnet whose hosts have no connectivity with the internet.",
"value": "Isolated"
},
{
"description": "A subnet range which is reserved, but no subnet will be created.",
"value": "Unused"
}
]
},
"awsx:ec2:VpcEndpointSpec": {
"description": "Provides a VPC Endpoint resource.\n\n\u003e **NOTE on VPC Endpoints and VPC Endpoint Associations:** The provider provides both standalone VPC Endpoint Associations for\nRoute Tables - (an association between a VPC endpoint and a single `route_table_id`),\nSecurity Groups - (an association between a VPC endpoint and a single `security_group_id`),\nand Subnets - (an association between a VPC endpoint and a single `subnet_id`) and\na VPC Endpoint resource with `route_table_ids` and `subnet_ids` attributes.\nDo not use the same resource ID in both a VPC Endpoint resource and a VPC Endpoint Association resource.\nDoing so will cause a conflict of associations and will overwrite the association.\n\n## Example Usage\n\n### Basic\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst s3 = new aws.ec2.VpcEndpoint(\"s3\", {\n vpcId: main.id,\n serviceName: \"com.amazonaws.us-west-2.s3\",\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\ns3 = aws.ec2.VpcEndpoint(\"s3\",\n vpc_id=main[\"id\"],\n service_name=\"com.amazonaws.us-west-2.s3\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var s3 = new Aws.Ec2.VpcEndpoint(\"s3\", new()\n {\n VpcId = main.Id,\n ServiceName = \"com.amazonaws.us-west-2.s3\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ec2.NewVpcEndpoint(ctx, \"s3\", \u0026ec2.VpcEndpointArgs{\n\t\t\tVpcId: pulumi.Any(main.Id),\n\t\t\tServiceName: pulumi.String(\"com.amazonaws.us-west-2.s3\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.ec2.VpcEndpoint;\nimport com.pulumi.aws.ec2.VpcEndpointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var s3 = new VpcEndpoint(\"s3\", VpcEndpointArgs.builder() \n .vpcId(main.id())\n .serviceName(\"com.amazonaws.us-west-2.s3\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n s3:\n type: aws:ec2:VpcEndpoint\n properties:\n vpcId: ${main.id}\n serviceName: com.amazonaws.us-west-2.s3\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Basic w/ Tags\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst s3 = new aws.ec2.VpcEndpoint(\"s3\", {\n vpcId: main.id,\n serviceName: \"com.amazonaws.us-west-2.s3\",\n tags: {\n Environment: \"test\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\ns3 = aws.ec2.VpcEndpoint(\"s3\",\n vpc_id=main[\"id\"],\n service_name=\"com.amazonaws.us-west-2.s3\",\n tags={\n \"Environment\": \"test\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var s3 = new Aws.Ec2.VpcEndpoint(\"s3\", new()\n {\n VpcId = main.Id,\n ServiceName = \"com.amazonaws.us-west-2.s3\",\n Tags = \n {\n { \"Environment\", \"test\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ec2.NewVpcEndpoint(ctx, \"s3\", \u0026ec2.VpcEndpointArgs{\n\t\t\tVpcId: pulumi.Any(main.Id),\n\t\t\tServiceName: pulumi.String(\"com.amazonaws.us-west-2.s3\"),\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"Environment\": pulumi.String(\"test\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.ec2.VpcEndpoint;\nimport com.pulumi.aws.ec2.VpcEndpointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var s3 = new VpcEndpoint(\"s3\", VpcEndpointArgs.builder() \n .vpcId(main.id())\n .serviceName(\"com.amazonaws.us-west-2.s3\")\n .tags(Map.of(\"Environment\", \"test\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n s3:\n type: aws:ec2:VpcEndpoint\n properties:\n vpcId: ${main.id}\n serviceName: com.amazonaws.us-west-2.s3\n tags:\n Environment: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Interface Endpoint Type\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst ec2 = new aws.ec2.VpcEndpoint(\"ec2\", {\n vpcId: main.id,\n serviceName: \"com.amazonaws.us-west-2.ec2\",\n vpcEndpointType: \"Interface\",\n securityGroupIds: [sg1.id],\n privateDnsEnabled: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\nec2 = aws.ec2.VpcEndpoint(\"ec2\",\n vpc_id=main[\"id\"],\n service_name=\"com.amazonaws.us-west-2.ec2\",\n vpc_endpoint_type=\"Interface\",\n security_group_ids=[sg1[\"id\"]],\n private_dns_enabled=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ec2 = new Aws.Ec2.VpcEndpoint(\"ec2\", new()\n {\n VpcId = main.Id,\n ServiceName = \"com.amazonaws.us-west-2.ec2\",\n VpcEndpointType = \"Interface\",\n SecurityGroupIds = new[]\n {\n sg1.Id,\n },\n PrivateDnsEnabled = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ec2.NewVpcEndpoint(ctx, \"ec2\", \u0026ec2.VpcEndpointArgs{\n\t\t\tVpcId: pulumi.Any(main.Id),\n\t\t\tServiceName: pulumi.String(\"com.amazonaws.us-west-2.ec2\"),\n\t\t\tVpcEndpointType: pulumi.String(\"Interface\"),\n\t\t\tSecurityGroupIds: pulumi.StringArray{\n\t\t\t\tsg1.Id,\n\t\t\t},\n\t\t\tPrivateDnsEnabled: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.ec2.VpcEndpoint;\nimport com.pulumi.aws.ec2.VpcEndpointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ec2 = new VpcEndpoint(\"ec2\", VpcEndpointArgs.builder() \n .vpcId(main.id())\n .serviceName(\"com.amazonaws.us-west-2.ec2\")\n .vpcEndpointType(\"Interface\")\n .securityGroupIds(sg1.id())\n .privateDnsEnabled(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ec2:\n type: aws:ec2:VpcEndpoint\n properties:\n vpcId: ${main.id}\n serviceName: com.amazonaws.us-west-2.ec2\n vpcEndpointType: Interface\n securityGroupIds:\n - ${sg1.id}\n privateDnsEnabled: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Gateway Load Balancer Endpoint Type\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst current = aws.getCallerIdentity({});\nconst example = new aws.ec2.VpcEndpointService(\"example\", {\n acceptanceRequired: false,\n allowedPrincipals: [current.then(current =\u003e current.arn)],\n gatewayLoadBalancerArns: [exampleAwsLb.arn],\n});\nconst exampleVpcEndpoint = new aws.ec2.VpcEndpoint(\"example\", {\n serviceName: example.serviceName,\n subnetIds: [exampleAwsSubnet.id],\n vpcEndpointType: example.serviceType,\n vpcId: exampleAwsVpc.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\ncurrent = aws.get_caller_identity()\nexample = aws.ec2.VpcEndpointService(\"example\",\n acceptance_required=False,\n allowed_principals=[current.arn],\n gateway_load_balancer_arns=[example_aws_lb[\"arn\"]])\nexample_vpc_endpoint = aws.ec2.VpcEndpoint(\"example\",\n service_name=example.service_name,\n subnet_ids=[example_aws_subnet[\"id\"]],\n vpc_endpoint_type=example.service_type,\n vpc_id=example_aws_vpc[\"id\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var current = Aws.GetCallerIdentity.Invoke();\n\n var example = new Aws.Ec2.VpcEndpointService(\"example\", new()\n {\n AcceptanceRequired = false,\n AllowedPrincipals = new[]\n {\n current.Apply(getCallerIdentityResult =\u003e getCallerIdentityResult.Arn),\n },\n GatewayLoadBalancerArns = new[]\n {\n exampleAwsLb.Arn,\n },\n });\n\n var exampleVpcEndpoint = new Aws.Ec2.VpcEndpoint(\"example\", new()\n {\n ServiceName = example.ServiceName,\n SubnetIds = new[]\n {\n exampleAwsSubnet.Id,\n },\n VpcEndpointType = example.ServiceType,\n VpcId = exampleAwsVpc.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws\"\n\t\"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcurrent, err := aws.GetCallerIdentity(ctx, nil, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texample, err := ec2.NewVpcEndpointService(ctx, \"example\", \u0026ec2.VpcEndpointServiceArgs{\n\t\t\tAcceptanceRequired: pulumi.Bool(false),\n\t\t\tAllowedPrincipals: pulumi.StringArray{\n\t\t\t\tpulumi.String(current.Arn),\n\t\t\t},\n\t\t\tGatewayLoadBalancerArns: pulumi.StringArray{\n\t\t\t\texampleAwsLb.Arn,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = ec2.NewVpcEndpoint(ctx, \"example\", \u0026ec2.VpcEndpointArgs{\n\t\t\tServiceName: example.ServiceName,\n\t\t\tSubnetIds: pulumi.StringArray{\n\t\t\t\texampleAwsSubnet.Id,\n\t\t\t},\n\t\t\tVpcEndpointType: example.ServiceType,\n\t\t\tVpcId: pulumi.Any(exampleAwsVpc.Id),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.AwsFunctions;\nimport com.pulumi.aws.inputs.GetCallerIdentityArgs;\nimport com.pulumi.aws.ec2.VpcEndpointService;\nimport com.pulumi.aws.ec2.VpcEndpointServiceArgs;\nimport com.pulumi.aws.ec2.VpcEndpoint;\nimport com.pulumi.aws.ec2.VpcEndpointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var current = AwsFunctions.getCallerIdentity();\n\n var example = new VpcEndpointService(\"example\", VpcEndpointServiceArgs.builder() \n .acceptanceRequired(false)\n .allowedPrincipals(current.applyValue(getCallerIdentityResult -\u003e getCallerIdentityResult.arn()))\n .gatewayLoadBalancerArns(exampleAwsLb.arn())\n .build());\n\n var exampleVpcEndpoint = new VpcEndpoint(\"exampleVpcEndpoint\", VpcEndpointArgs.builder() \n .serviceName(example.serviceName())\n .subnetIds(exampleAwsSubnet.id())\n .vpcEndpointType(example.serviceType())\n .vpcId(exampleAwsVpc.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n example:\n type: aws:ec2:VpcEndpointService\n properties:\n acceptanceRequired: false\n allowedPrincipals:\n - ${current.arn}\n gatewayLoadBalancerArns:\n - ${exampleAwsLb.arn}\n exampleVpcEndpoint:\n type: aws:ec2:VpcEndpoint\n name: example\n properties:\n serviceName: ${example.serviceName}\n subnetIds:\n - ${exampleAwsSubnet.id}\n vpcEndpointType: ${example.serviceType}\n vpcId: ${exampleAwsVpc.id}\nvariables:\n current:\n fn::invoke:\n Function: aws:getCallerIdentity\n Arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\nUsing `pulumi import`, import VPC Endpoints using the VPC endpoint `id`. For example:\n\n```sh\n$ pulumi import aws:ec2/vpcEndpoint:VpcEndpoint endpoint1 vpce-3ecf2a57\n```\n",
"properties": {
"autoAccept": {
"type": "boolean",
"plain": true,
"description": "Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account)."
},
"dnsOptions": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ec2/VpcEndpointDnsOptions:VpcEndpointDnsOptions",
"description": "The DNS options for the endpoint. See dns_options below.\n"
},
"ipAddressType": {
"type": "string",
"description": "The IP address type for the endpoint. Valid values are `ipv4`, `dualstack`, and `ipv6`.\n"
},
"policy": {
"type": "string",
"description": "A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details.\n"
},
"privateDnsEnabled": {
"type": "boolean",
"plain": true,
"description": "Whether or not to associate a private hosted zone with the specified VPC. Applicable for endpoints of type Interface. Defaults to `false`."
},
"routeTableIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "One or more route table IDs. Applicable for endpoints of type `Gateway`.\n"
},
"securityGroupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of one or more security groups to associate with the network interface. Applicable for endpoints of type `Interface`.\nIf no security groups are specified, the VPC's [default security group](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#DefaultSecurityGroup) is associated with the endpoint.\n"
},
"serviceName": {
"type": "string",
"plain": true,
"description": "The service name. For AWS services the service name is usually in the form `com.amazonaws.\u003cregion\u003e.\u003cservice\u003e` (the SageMaker Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.\u003cregion\u003e.notebook`)."
},
"subnetIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of one or more subnets in which to create a network interface for the endpoint. Applicable for endpoints of type `GatewayLoadBalancer` and `Interface`. Interface type endpoints cannot function without being assigned to a subnet.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
},
"vpcEndpointType": {
"type": "string",
"description": "The VPC endpoint type, `Gateway`, `GatewayLoadBalancer`, or `Interface`. Defaults to `Gateway`.\n",
"willReplaceOnChanges": true
}
},
"type": "object",
"required": [
"serviceName"
]
},
"awsx:ecr:BuilderVersion": {
"description": "The version of the Docker builder",
"type": "string",
"enum": [
{
"description": "The first generation builder for Docker Daemon.",
"value": "BuilderV1"
},
{
"description": "The builder based on moby/buildkit project",
"value": "BuilderBuildKit"
}
]
},
"awsx:ecr:DockerBuild": {
"description": "Arguments for building a docker image",
"properties": {
"args": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "An optional map of named build-time argument variables to set during the Docker build. This flag allows you to pass built-time variables that can be accessed like environment variables inside the `RUN` instruction."
},
"builderVersion": {
"$ref": "#/types/awsx:ecr:BuilderVersion",
"plain": true,
"description": "The version of the Docker builder."
},
"cacheFrom": {
"type": "array",
"items": {
"type": "string"
},
"description": "Images to consider as cache sources"
},
"context": {
"type": "string",
"description": "Path to a directory to use for the Docker build context, usually the directory in which the Dockerfile resides (although dockerfile may be used to choose a custom location independent of this choice). If not specified, the context defaults to the current working directory; if a relative path is used, it is relative to the current working directory that Pulumi is evaluating."
},
"dockerfile": {
"type": "string",
"description": "dockerfile may be used to override the default Dockerfile name and/or location. By default, it is assumed to be a file named Dockerfile in the root of the build context."
},
"imageName": {
"type": "string",
"description": "Custom name for the underlying Docker image resource. If omitted, the image tag assigned by the provider will be used"
},
"imageTag": {
"type": "string",
"description": "Custom image tag for the resulting docker image. If omitted a random string will be used"
},
"platform": {
"type": "string",
"description": "The architecture of the platform you want to build this image for, e.g. `linux/arm64`."
},
"target": {
"type": "string",
"description": "The target of the dockerfile to build"
}
},
"type": "object"
},
"awsx:ecr:lifecyclePolicy": {
"description": "Simplified lifecycle policy model consisting of one or more rules that determine which images in a repository should be expired. See https://docs.aws.amazon.com/AmazonECR/latest/userguide/lifecycle_policy_examples.html for more details.",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/types/awsx:ecr:lifecyclePolicyRule"
},
"description": "Specifies the rules to determine how images should be retired from this repository. Rules are ordered from lowest priority to highest. If there is a rule with a `selection` value of `any`, then it will have the highest priority."
},
"skip": {
"type": "boolean",
"plain": true,
"description": "Skips creation of the policy if set to `true`."
}
},
"type": "object"
},
"awsx:ecr:lifecyclePolicyRule": {
"description": "A lifecycle policy rule that determine which images in a repository should be expired.",
"properties": {
"description": {
"type": "string",
"description": "Describes the purpose of a rule within a lifecycle policy."
},
"maximumAgeLimit": {
"type": "number",
"description": "The maximum age limit (in days) for your images. Either [maximumNumberOfImages] or [maximumAgeLimit] must be provided."
},
"maximumNumberOfImages": {
"type": "number",
"description": "The maximum number of images that you want to retain in your repository. Either [maximumNumberOfImages] or [maximumAgeLimit] must be provided."
},
"tagPrefixList": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of image tag prefixes on which to take action with your lifecycle policy. Only used if you specified \"tagStatus\": \"tagged\". For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag prefix prod to specify all of them. If you specify multiple tags, only the images with all specified tags are selected."
},
"tagStatus": {
"$ref": "#/types/awsx:ecr:lifecycleTagStatus",
"description": "Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are tagged, untagged, or any. If you specify any, then all images have the rule evaluated against them. If you specify tagged, then you must also specify a tagPrefixList value. If you specify untagged, then you must omit tagPrefixList."
}
},
"type": "object",
"required": [
"tagStatus"
]
},
"awsx:ecr:lifecycleTagStatus": {
"type": "string",
"enum": [
{
"name": "any",
"description": "Evaluate rule against all images",
"value": "any"
},
{
"name": "untagged",
"description": "Only evaluate rule against untagged images",
"value": "untagged"
},
{
"name": "tagged",
"description": "Only evaluated rule against images with specified prefixes",
"value": "tagged"
}
]
},
"awsx:ecs:EC2ServiceTaskDefinition": {
"description": "Create a TaskDefinition resource with the given unique name, arguments, and options.\nCreates required log-group and task \u0026 execution roles.\nPresents required Service load balancers if target group included in port mappings.",
"properties": {
"container": {
"$ref": "#/types/awsx:ecs:TaskDefinitionContainerDefinition",
"plain": true,
"description": "Single container to make a TaskDefinition from. Useful for simple cases where there aren't\nmultiple containers, especially when creating a TaskDefinition to call [run] on.\n\nEither [container] or [containers] must be provided."
},
"containers": {
"type": "object",
"additionalProperties": {
"$ref": "#/types/awsx:ecs:TaskDefinitionContainerDefinition",
"plain": true
},
"plain": true,
"description": "All the containers to make a TaskDefinition from. Useful when creating a Service that will\ncontain many containers within.\n\nEither [container] or [containers] must be provided."
},
"cpu": {
"type": "string",
"description": "The number of cpu units used by the task. If not provided, a default will be computed based on the cumulative needs specified by [containerDefinitions]"
},
"ephemeralStorage": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ecs/TaskDefinitionEphemeralStorage:TaskDefinitionEphemeralStorage",
"description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.\n",
"willReplaceOnChanges": true
},
"executionRole": {
"$ref": "#/types/awsx:awsx:DefaultRoleWithPolicy",
"plain": true,
"description": "The execution role that the Amazon ECS container agent and the Docker daemon can assume.\nWill be created automatically if not defined."
},
"family": {
"type": "string",
"description": "An optional unique name for your task definition. If not specified, then a default will be created."
},
"inferenceAccelerators": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ecs/TaskDefinitionInferenceAccelerator:TaskDefinitionInferenceAccelerator"
},
"description": "Configuration block(s) with Inference Accelerators settings. Detailed below.\n",
"willReplaceOnChanges": true
},
"ipcMode": {
"type": "string",
"description": "IPC resource namespace to be used for the containers in the task The valid values are `host`, `task`, and `none`.\n",
"willReplaceOnChanges": true
},
"logGroup": {
"$ref": "#/types/awsx:awsx:DefaultLogGroup",
"plain": true,
"description": "A set of volume blocks that containers in your task may use."
},
"memory": {
"type": "string",
"description": "The amount (in MiB) of memory used by the task. If not provided, a default will be computed\nbased on the cumulative needs specified by [containerDefinitions]"
},
"networkMode": {
"type": "string",
"description": "Docker networking mode to use for the containers in the task. Valid values are `none`, `bridge`, `awsvpc`, and `host`.\n",
"willReplaceOnChanges": true
},
"pidMode": {
"type": "string",
"description": "Process namespace to use for the containers in the task. The valid values are `host` and `task`.\n",
"willReplaceOnChanges": true
},
"placementConstraints": {
"type": "array",
"items": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ecs/TaskDefinitionPlacementConstraint:TaskDefinitionPlacementConstraint"
},
"description": "Configuration block for rules that are taken into consideration during task placement. Maximum number of `placement_constraints` is `10`. Detailed below.\n",
"willReplaceOnChanges": true
},
"proxyConfiguration": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ecs/TaskDefinitionProxyConfiguration:TaskDefinitionProxyConfiguration",
"description": "Configuration block for the App Mesh proxy. Detailed below.\n",
"willReplaceOnChanges": true
},
"runtimePlatform": {
"$ref": "/aws/v6.32.0/schema.json#/types/aws:ecs/TaskDefinitionRuntimePlatform:TaskDefinitionRuntimePlatform",
"description": "Configuration block for runtime_platform that containers in your task may use.\n",
"willReplaceOnChanges": true
},
"skipDestroy": {
"type": "boolean",
"description": "Whether to retain the old revision when the resource is destroyed or replacement is necessary. Default is `false`.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.\n"
},
"taskRole": {
"$ref": "#/types/awsx:awsx:DefaultRoleWithPolicy",
"plain": true,
"description": "IAM role that allows your Amazon ECS container task to make calls to other AWS services.\nWill be created automatically if not defined."
},
"trackLatest": {