pulumi-webflow 0.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_webflow/__init__.py +76 -0
- pulumi_webflow/_inputs.py +254 -0
- pulumi_webflow/_utilities.py +331 -0
- pulumi_webflow/asset.py +334 -0
- pulumi_webflow/asset_folder.py +225 -0
- pulumi_webflow/collection.py +235 -0
- pulumi_webflow/collection_field.py +322 -0
- pulumi_webflow/collection_item.py +283 -0
- pulumi_webflow/config/__init__.py +9 -0
- pulumi_webflow/config/__init__.pyi +21 -0
- pulumi_webflow/config/vars.py +29 -0
- pulumi_webflow/ecommerce_settings.py +146 -0
- pulumi_webflow/get_authorized_user.py +109 -0
- pulumi_webflow/get_token_info.py +82 -0
- pulumi_webflow/outputs.py +455 -0
- pulumi_webflow/page_content.py +172 -0
- pulumi_webflow/page_custom_code.py +178 -0
- pulumi_webflow/page_data.py +256 -0
- pulumi_webflow/provider.py +106 -0
- pulumi_webflow/pulumi-plugin.json +4 -0
- pulumi_webflow/py.typed +0 -0
- pulumi_webflow/redirect.py +226 -0
- pulumi_webflow/registered_script.py +295 -0
- pulumi_webflow/robots_txt.py +166 -0
- pulumi_webflow/site.py +361 -0
- pulumi_webflow/site_custom_code.py +178 -0
- pulumi_webflow/user.py +284 -0
- pulumi_webflow/webhook.py +235 -0
- pulumi_webflow-0.0.0.dist-info/METADATA +602 -0
- pulumi_webflow-0.0.0.dist-info/RECORD +32 -0
- pulumi_webflow-0.0.0.dist-info/WHEEL +5 -0
- pulumi_webflow-0.0.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# coding=utf-8
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
|
+
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
|
+
|
|
5
|
+
import builtins as _builtins
|
|
6
|
+
import warnings
|
|
7
|
+
import sys
|
|
8
|
+
import pulumi
|
|
9
|
+
import pulumi.runtime
|
|
10
|
+
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
15
|
+
from . import _utilities
|
|
16
|
+
|
|
17
|
+
__all__ = ['CollectionArgs', 'Collection']
|
|
18
|
+
|
|
19
|
+
@pulumi.input_type
|
|
20
|
+
class CollectionArgs:
|
|
21
|
+
def __init__(__self__, *,
|
|
22
|
+
display_name: pulumi.Input[_builtins.str],
|
|
23
|
+
singular_name: pulumi.Input[_builtins.str],
|
|
24
|
+
site_id: pulumi.Input[_builtins.str],
|
|
25
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None):
|
|
26
|
+
"""
|
|
27
|
+
The set of arguments for constructing a Collection resource.
|
|
28
|
+
:param pulumi.Input[_builtins.str] display_name: The human-readable name of the collection (e.g., 'Blog Posts', 'Products', 'Team Members'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
29
|
+
:param pulumi.Input[_builtins.str] singular_name: The singular form of the collection name (e.g., 'Blog Post' for 'Blog Posts', 'Product' for 'Products'). Used in the CMS UI when referring to individual items. Maximum length: 255 characters.
|
|
30
|
+
:param pulumi.Input[_builtins.str] site_id: The Webflow site ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find your site ID in the Webflow dashboard under Site Settings. This field will be validated before making any API calls.
|
|
31
|
+
:param pulumi.Input[_builtins.str] slug: The URL-friendly slug for the collection (optional, e.g., 'blog-posts', 'products'). If not provided, Webflow will auto-generate a slug from the displayName. The slug determines the URL path for collection items.
|
|
32
|
+
"""
|
|
33
|
+
pulumi.set(__self__, "display_name", display_name)
|
|
34
|
+
pulumi.set(__self__, "singular_name", singular_name)
|
|
35
|
+
pulumi.set(__self__, "site_id", site_id)
|
|
36
|
+
if slug is not None:
|
|
37
|
+
pulumi.set(__self__, "slug", slug)
|
|
38
|
+
|
|
39
|
+
@_builtins.property
|
|
40
|
+
@pulumi.getter(name="displayName")
|
|
41
|
+
def display_name(self) -> pulumi.Input[_builtins.str]:
|
|
42
|
+
"""
|
|
43
|
+
The human-readable name of the collection (e.g., 'Blog Posts', 'Products', 'Team Members'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
44
|
+
"""
|
|
45
|
+
return pulumi.get(self, "display_name")
|
|
46
|
+
|
|
47
|
+
@display_name.setter
|
|
48
|
+
def display_name(self, value: pulumi.Input[_builtins.str]):
|
|
49
|
+
pulumi.set(self, "display_name", value)
|
|
50
|
+
|
|
51
|
+
@_builtins.property
|
|
52
|
+
@pulumi.getter(name="singularName")
|
|
53
|
+
def singular_name(self) -> pulumi.Input[_builtins.str]:
|
|
54
|
+
"""
|
|
55
|
+
The singular form of the collection name (e.g., 'Blog Post' for 'Blog Posts', 'Product' for 'Products'). Used in the CMS UI when referring to individual items. Maximum length: 255 characters.
|
|
56
|
+
"""
|
|
57
|
+
return pulumi.get(self, "singular_name")
|
|
58
|
+
|
|
59
|
+
@singular_name.setter
|
|
60
|
+
def singular_name(self, value: pulumi.Input[_builtins.str]):
|
|
61
|
+
pulumi.set(self, "singular_name", value)
|
|
62
|
+
|
|
63
|
+
@_builtins.property
|
|
64
|
+
@pulumi.getter(name="siteId")
|
|
65
|
+
def site_id(self) -> pulumi.Input[_builtins.str]:
|
|
66
|
+
"""
|
|
67
|
+
The Webflow site ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find your site ID in the Webflow dashboard under Site Settings. This field will be validated before making any API calls.
|
|
68
|
+
"""
|
|
69
|
+
return pulumi.get(self, "site_id")
|
|
70
|
+
|
|
71
|
+
@site_id.setter
|
|
72
|
+
def site_id(self, value: pulumi.Input[_builtins.str]):
|
|
73
|
+
pulumi.set(self, "site_id", value)
|
|
74
|
+
|
|
75
|
+
@_builtins.property
|
|
76
|
+
@pulumi.getter
|
|
77
|
+
def slug(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
78
|
+
"""
|
|
79
|
+
The URL-friendly slug for the collection (optional, e.g., 'blog-posts', 'products'). If not provided, Webflow will auto-generate a slug from the displayName. The slug determines the URL path for collection items.
|
|
80
|
+
"""
|
|
81
|
+
return pulumi.get(self, "slug")
|
|
82
|
+
|
|
83
|
+
@slug.setter
|
|
84
|
+
def slug(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
85
|
+
pulumi.set(self, "slug", value)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
@pulumi.type_token("webflow:index:Collection")
|
|
89
|
+
class Collection(pulumi.CustomResource):
|
|
90
|
+
@overload
|
|
91
|
+
def __init__(__self__,
|
|
92
|
+
resource_name: str,
|
|
93
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
94
|
+
display_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
95
|
+
singular_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
96
|
+
site_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
97
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None,
|
|
98
|
+
__props__=None):
|
|
99
|
+
"""
|
|
100
|
+
Manages CMS collections for a Webflow site. Collections are containers for structured content items (blog posts, products, etc.). Note: Webflow collections do not support updates - any changes require replacement (delete + recreate).
|
|
101
|
+
|
|
102
|
+
:param str resource_name: The name of the resource.
|
|
103
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
104
|
+
:param pulumi.Input[_builtins.str] display_name: The human-readable name of the collection (e.g., 'Blog Posts', 'Products', 'Team Members'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
105
|
+
:param pulumi.Input[_builtins.str] singular_name: The singular form of the collection name (e.g., 'Blog Post' for 'Blog Posts', 'Product' for 'Products'). Used in the CMS UI when referring to individual items. Maximum length: 255 characters.
|
|
106
|
+
:param pulumi.Input[_builtins.str] site_id: The Webflow site ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find your site ID in the Webflow dashboard under Site Settings. This field will be validated before making any API calls.
|
|
107
|
+
:param pulumi.Input[_builtins.str] slug: The URL-friendly slug for the collection (optional, e.g., 'blog-posts', 'products'). If not provided, Webflow will auto-generate a slug from the displayName. The slug determines the URL path for collection items.
|
|
108
|
+
"""
|
|
109
|
+
...
|
|
110
|
+
@overload
|
|
111
|
+
def __init__(__self__,
|
|
112
|
+
resource_name: str,
|
|
113
|
+
args: CollectionArgs,
|
|
114
|
+
opts: Optional[pulumi.ResourceOptions] = None):
|
|
115
|
+
"""
|
|
116
|
+
Manages CMS collections for a Webflow site. Collections are containers for structured content items (blog posts, products, etc.). Note: Webflow collections do not support updates - any changes require replacement (delete + recreate).
|
|
117
|
+
|
|
118
|
+
:param str resource_name: The name of the resource.
|
|
119
|
+
:param CollectionArgs args: The arguments to use to populate this resource's properties.
|
|
120
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
121
|
+
"""
|
|
122
|
+
...
|
|
123
|
+
def __init__(__self__, resource_name: str, *args, **kwargs):
|
|
124
|
+
resource_args, opts = _utilities.get_resource_args_opts(CollectionArgs, pulumi.ResourceOptions, *args, **kwargs)
|
|
125
|
+
if resource_args is not None:
|
|
126
|
+
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
|
127
|
+
else:
|
|
128
|
+
__self__._internal_init(resource_name, *args, **kwargs)
|
|
129
|
+
|
|
130
|
+
def _internal_init(__self__,
|
|
131
|
+
resource_name: str,
|
|
132
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
133
|
+
display_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
134
|
+
singular_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
135
|
+
site_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
136
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None,
|
|
137
|
+
__props__=None):
|
|
138
|
+
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
139
|
+
if not isinstance(opts, pulumi.ResourceOptions):
|
|
140
|
+
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
|
141
|
+
if opts.id is None:
|
|
142
|
+
if __props__ is not None:
|
|
143
|
+
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
|
144
|
+
__props__ = CollectionArgs.__new__(CollectionArgs)
|
|
145
|
+
|
|
146
|
+
if display_name is None and not opts.urn:
|
|
147
|
+
raise TypeError("Missing required property 'display_name'")
|
|
148
|
+
__props__.__dict__["display_name"] = display_name
|
|
149
|
+
if singular_name is None and not opts.urn:
|
|
150
|
+
raise TypeError("Missing required property 'singular_name'")
|
|
151
|
+
__props__.__dict__["singular_name"] = singular_name
|
|
152
|
+
if site_id is None and not opts.urn:
|
|
153
|
+
raise TypeError("Missing required property 'site_id'")
|
|
154
|
+
__props__.__dict__["site_id"] = site_id
|
|
155
|
+
__props__.__dict__["slug"] = slug
|
|
156
|
+
__props__.__dict__["created_on"] = None
|
|
157
|
+
__props__.__dict__["last_updated"] = None
|
|
158
|
+
super(Collection, __self__).__init__(
|
|
159
|
+
'webflow:index:Collection',
|
|
160
|
+
resource_name,
|
|
161
|
+
__props__,
|
|
162
|
+
opts)
|
|
163
|
+
|
|
164
|
+
@staticmethod
|
|
165
|
+
def get(resource_name: str,
|
|
166
|
+
id: pulumi.Input[str],
|
|
167
|
+
opts: Optional[pulumi.ResourceOptions] = None) -> 'Collection':
|
|
168
|
+
"""
|
|
169
|
+
Get an existing Collection resource's state with the given name, id, and optional extra
|
|
170
|
+
properties used to qualify the lookup.
|
|
171
|
+
|
|
172
|
+
:param str resource_name: The unique name of the resulting resource.
|
|
173
|
+
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
174
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
175
|
+
"""
|
|
176
|
+
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
177
|
+
|
|
178
|
+
__props__ = CollectionArgs.__new__(CollectionArgs)
|
|
179
|
+
|
|
180
|
+
__props__.__dict__["created_on"] = None
|
|
181
|
+
__props__.__dict__["display_name"] = None
|
|
182
|
+
__props__.__dict__["last_updated"] = None
|
|
183
|
+
__props__.__dict__["singular_name"] = None
|
|
184
|
+
__props__.__dict__["site_id"] = None
|
|
185
|
+
__props__.__dict__["slug"] = None
|
|
186
|
+
return Collection(resource_name, opts=opts, __props__=__props__)
|
|
187
|
+
|
|
188
|
+
@_builtins.property
|
|
189
|
+
@pulumi.getter(name="createdOn")
|
|
190
|
+
def created_on(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
191
|
+
"""
|
|
192
|
+
The timestamp when the collection was created (RFC3339 format). This is automatically set by Webflow and is read-only.
|
|
193
|
+
"""
|
|
194
|
+
return pulumi.get(self, "created_on")
|
|
195
|
+
|
|
196
|
+
@_builtins.property
|
|
197
|
+
@pulumi.getter(name="displayName")
|
|
198
|
+
def display_name(self) -> pulumi.Output[_builtins.str]:
|
|
199
|
+
"""
|
|
200
|
+
The human-readable name of the collection (e.g., 'Blog Posts', 'Products', 'Team Members'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
201
|
+
"""
|
|
202
|
+
return pulumi.get(self, "display_name")
|
|
203
|
+
|
|
204
|
+
@_builtins.property
|
|
205
|
+
@pulumi.getter(name="lastUpdated")
|
|
206
|
+
def last_updated(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
207
|
+
"""
|
|
208
|
+
The timestamp when the collection was last updated (RFC3339 format). This is automatically updated by Webflow and is read-only.
|
|
209
|
+
"""
|
|
210
|
+
return pulumi.get(self, "last_updated")
|
|
211
|
+
|
|
212
|
+
@_builtins.property
|
|
213
|
+
@pulumi.getter(name="singularName")
|
|
214
|
+
def singular_name(self) -> pulumi.Output[_builtins.str]:
|
|
215
|
+
"""
|
|
216
|
+
The singular form of the collection name (e.g., 'Blog Post' for 'Blog Posts', 'Product' for 'Products'). Used in the CMS UI when referring to individual items. Maximum length: 255 characters.
|
|
217
|
+
"""
|
|
218
|
+
return pulumi.get(self, "singular_name")
|
|
219
|
+
|
|
220
|
+
@_builtins.property
|
|
221
|
+
@pulumi.getter(name="siteId")
|
|
222
|
+
def site_id(self) -> pulumi.Output[_builtins.str]:
|
|
223
|
+
"""
|
|
224
|
+
The Webflow site ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find your site ID in the Webflow dashboard under Site Settings. This field will be validated before making any API calls.
|
|
225
|
+
"""
|
|
226
|
+
return pulumi.get(self, "site_id")
|
|
227
|
+
|
|
228
|
+
@_builtins.property
|
|
229
|
+
@pulumi.getter
|
|
230
|
+
def slug(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
231
|
+
"""
|
|
232
|
+
The URL-friendly slug for the collection (optional, e.g., 'blog-posts', 'products'). If not provided, Webflow will auto-generate a slug from the displayName. The slug determines the URL path for collection items.
|
|
233
|
+
"""
|
|
234
|
+
return pulumi.get(self, "slug")
|
|
235
|
+
|
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
# coding=utf-8
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
|
+
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
|
+
|
|
5
|
+
import builtins as _builtins
|
|
6
|
+
import warnings
|
|
7
|
+
import sys
|
|
8
|
+
import pulumi
|
|
9
|
+
import pulumi.runtime
|
|
10
|
+
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
15
|
+
from . import _utilities
|
|
16
|
+
|
|
17
|
+
__all__ = ['CollectionFieldArgs', 'CollectionField']
|
|
18
|
+
|
|
19
|
+
@pulumi.input_type
|
|
20
|
+
class CollectionFieldArgs:
|
|
21
|
+
def __init__(__self__, *,
|
|
22
|
+
collection_id: pulumi.Input[_builtins.str],
|
|
23
|
+
display_name: pulumi.Input[_builtins.str],
|
|
24
|
+
type: pulumi.Input[_builtins.str],
|
|
25
|
+
help_text: Optional[pulumi.Input[_builtins.str]] = None,
|
|
26
|
+
is_required: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
27
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None,
|
|
28
|
+
validations: Optional[pulumi.Input[Mapping[str, Any]]] = None):
|
|
29
|
+
"""
|
|
30
|
+
The set of arguments for constructing a CollectionField resource.
|
|
31
|
+
:param pulumi.Input[_builtins.str] collection_id: The Webflow collection ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find collection IDs via the Webflow API or dashboard. This field will be validated before making any API calls.
|
|
32
|
+
:param pulumi.Input[_builtins.str] display_name: The human-readable name of the field (e.g., 'Title', 'Description', 'Author'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
33
|
+
:param pulumi.Input[_builtins.str] type: The field type (e.g., 'PlainText', 'RichText', 'Image', 'Number'). Supported types: PlainText, RichText, Image, MultiImage, Video, Link, Email, Phone, Number, DateTime, Switch, Color, Option, File, Reference, MultiReference. IMPORTANT: Cannot be changed after creation - changing this requires replacement.
|
|
34
|
+
:param pulumi.Input[_builtins.str] help_text: Optional help text shown in the CMS interface (e.g., 'Enter the article title'). Helps content editors understand what to enter in this field.
|
|
35
|
+
:param pulumi.Input[_builtins.bool] is_required: Whether the field is required (optional, defaults to false). When true, content items must provide a value for this field.
|
|
36
|
+
:param pulumi.Input[_builtins.str] slug: The URL-friendly slug for the field (optional, e.g., 'title', 'description'). If not provided, Webflow will auto-generate a slug from the displayName. The slug is used in API requests and exports.
|
|
37
|
+
:param pulumi.Input[Mapping[str, Any]] validations: Type-specific validation rules (optional). Different field types support different validations. Example for Number type: {"min": 0, "max": 100}. Example for PlainText type: {"maxLength": 500}. Refer to Webflow API documentation for validation options for each field type.
|
|
38
|
+
"""
|
|
39
|
+
pulumi.set(__self__, "collection_id", collection_id)
|
|
40
|
+
pulumi.set(__self__, "display_name", display_name)
|
|
41
|
+
pulumi.set(__self__, "type", type)
|
|
42
|
+
if help_text is not None:
|
|
43
|
+
pulumi.set(__self__, "help_text", help_text)
|
|
44
|
+
if is_required is not None:
|
|
45
|
+
pulumi.set(__self__, "is_required", is_required)
|
|
46
|
+
if slug is not None:
|
|
47
|
+
pulumi.set(__self__, "slug", slug)
|
|
48
|
+
if validations is not None:
|
|
49
|
+
pulumi.set(__self__, "validations", validations)
|
|
50
|
+
|
|
51
|
+
@_builtins.property
|
|
52
|
+
@pulumi.getter(name="collectionId")
|
|
53
|
+
def collection_id(self) -> pulumi.Input[_builtins.str]:
|
|
54
|
+
"""
|
|
55
|
+
The Webflow collection ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find collection IDs via the Webflow API or dashboard. This field will be validated before making any API calls.
|
|
56
|
+
"""
|
|
57
|
+
return pulumi.get(self, "collection_id")
|
|
58
|
+
|
|
59
|
+
@collection_id.setter
|
|
60
|
+
def collection_id(self, value: pulumi.Input[_builtins.str]):
|
|
61
|
+
pulumi.set(self, "collection_id", value)
|
|
62
|
+
|
|
63
|
+
@_builtins.property
|
|
64
|
+
@pulumi.getter(name="displayName")
|
|
65
|
+
def display_name(self) -> pulumi.Input[_builtins.str]:
|
|
66
|
+
"""
|
|
67
|
+
The human-readable name of the field (e.g., 'Title', 'Description', 'Author'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
68
|
+
"""
|
|
69
|
+
return pulumi.get(self, "display_name")
|
|
70
|
+
|
|
71
|
+
@display_name.setter
|
|
72
|
+
def display_name(self, value: pulumi.Input[_builtins.str]):
|
|
73
|
+
pulumi.set(self, "display_name", value)
|
|
74
|
+
|
|
75
|
+
@_builtins.property
|
|
76
|
+
@pulumi.getter
|
|
77
|
+
def type(self) -> pulumi.Input[_builtins.str]:
|
|
78
|
+
"""
|
|
79
|
+
The field type (e.g., 'PlainText', 'RichText', 'Image', 'Number'). Supported types: PlainText, RichText, Image, MultiImage, Video, Link, Email, Phone, Number, DateTime, Switch, Color, Option, File, Reference, MultiReference. IMPORTANT: Cannot be changed after creation - changing this requires replacement.
|
|
80
|
+
"""
|
|
81
|
+
return pulumi.get(self, "type")
|
|
82
|
+
|
|
83
|
+
@type.setter
|
|
84
|
+
def type(self, value: pulumi.Input[_builtins.str]):
|
|
85
|
+
pulumi.set(self, "type", value)
|
|
86
|
+
|
|
87
|
+
@_builtins.property
|
|
88
|
+
@pulumi.getter(name="helpText")
|
|
89
|
+
def help_text(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
90
|
+
"""
|
|
91
|
+
Optional help text shown in the CMS interface (e.g., 'Enter the article title'). Helps content editors understand what to enter in this field.
|
|
92
|
+
"""
|
|
93
|
+
return pulumi.get(self, "help_text")
|
|
94
|
+
|
|
95
|
+
@help_text.setter
|
|
96
|
+
def help_text(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
97
|
+
pulumi.set(self, "help_text", value)
|
|
98
|
+
|
|
99
|
+
@_builtins.property
|
|
100
|
+
@pulumi.getter(name="isRequired")
|
|
101
|
+
def is_required(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
102
|
+
"""
|
|
103
|
+
Whether the field is required (optional, defaults to false). When true, content items must provide a value for this field.
|
|
104
|
+
"""
|
|
105
|
+
return pulumi.get(self, "is_required")
|
|
106
|
+
|
|
107
|
+
@is_required.setter
|
|
108
|
+
def is_required(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
109
|
+
pulumi.set(self, "is_required", value)
|
|
110
|
+
|
|
111
|
+
@_builtins.property
|
|
112
|
+
@pulumi.getter
|
|
113
|
+
def slug(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
114
|
+
"""
|
|
115
|
+
The URL-friendly slug for the field (optional, e.g., 'title', 'description'). If not provided, Webflow will auto-generate a slug from the displayName. The slug is used in API requests and exports.
|
|
116
|
+
"""
|
|
117
|
+
return pulumi.get(self, "slug")
|
|
118
|
+
|
|
119
|
+
@slug.setter
|
|
120
|
+
def slug(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
121
|
+
pulumi.set(self, "slug", value)
|
|
122
|
+
|
|
123
|
+
@_builtins.property
|
|
124
|
+
@pulumi.getter
|
|
125
|
+
def validations(self) -> Optional[pulumi.Input[Mapping[str, Any]]]:
|
|
126
|
+
"""
|
|
127
|
+
Type-specific validation rules (optional). Different field types support different validations. Example for Number type: {"min": 0, "max": 100}. Example for PlainText type: {"maxLength": 500}. Refer to Webflow API documentation for validation options for each field type.
|
|
128
|
+
"""
|
|
129
|
+
return pulumi.get(self, "validations")
|
|
130
|
+
|
|
131
|
+
@validations.setter
|
|
132
|
+
def validations(self, value: Optional[pulumi.Input[Mapping[str, Any]]]):
|
|
133
|
+
pulumi.set(self, "validations", value)
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
@pulumi.type_token("webflow:index:CollectionField")
|
|
137
|
+
class CollectionField(pulumi.CustomResource):
|
|
138
|
+
@overload
|
|
139
|
+
def __init__(__self__,
|
|
140
|
+
resource_name: str,
|
|
141
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
142
|
+
collection_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
143
|
+
display_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
144
|
+
help_text: Optional[pulumi.Input[_builtins.str]] = None,
|
|
145
|
+
is_required: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
146
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None,
|
|
147
|
+
type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
148
|
+
validations: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
|
149
|
+
__props__=None):
|
|
150
|
+
"""
|
|
151
|
+
Manages fields for a Webflow CMS collection. Collection fields define the structure of content items in a collection. Note: The field type cannot be changed after creation - changing it requires replacement (delete + recreate).
|
|
152
|
+
|
|
153
|
+
:param str resource_name: The name of the resource.
|
|
154
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
155
|
+
:param pulumi.Input[_builtins.str] collection_id: The Webflow collection ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find collection IDs via the Webflow API or dashboard. This field will be validated before making any API calls.
|
|
156
|
+
:param pulumi.Input[_builtins.str] display_name: The human-readable name of the field (e.g., 'Title', 'Description', 'Author'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
157
|
+
:param pulumi.Input[_builtins.str] help_text: Optional help text shown in the CMS interface (e.g., 'Enter the article title'). Helps content editors understand what to enter in this field.
|
|
158
|
+
:param pulumi.Input[_builtins.bool] is_required: Whether the field is required (optional, defaults to false). When true, content items must provide a value for this field.
|
|
159
|
+
:param pulumi.Input[_builtins.str] slug: The URL-friendly slug for the field (optional, e.g., 'title', 'description'). If not provided, Webflow will auto-generate a slug from the displayName. The slug is used in API requests and exports.
|
|
160
|
+
:param pulumi.Input[_builtins.str] type: The field type (e.g., 'PlainText', 'RichText', 'Image', 'Number'). Supported types: PlainText, RichText, Image, MultiImage, Video, Link, Email, Phone, Number, DateTime, Switch, Color, Option, File, Reference, MultiReference. IMPORTANT: Cannot be changed after creation - changing this requires replacement.
|
|
161
|
+
:param pulumi.Input[Mapping[str, Any]] validations: Type-specific validation rules (optional). Different field types support different validations. Example for Number type: {"min": 0, "max": 100}. Example for PlainText type: {"maxLength": 500}. Refer to Webflow API documentation for validation options for each field type.
|
|
162
|
+
"""
|
|
163
|
+
...
|
|
164
|
+
@overload
|
|
165
|
+
def __init__(__self__,
|
|
166
|
+
resource_name: str,
|
|
167
|
+
args: CollectionFieldArgs,
|
|
168
|
+
opts: Optional[pulumi.ResourceOptions] = None):
|
|
169
|
+
"""
|
|
170
|
+
Manages fields for a Webflow CMS collection. Collection fields define the structure of content items in a collection. Note: The field type cannot be changed after creation - changing it requires replacement (delete + recreate).
|
|
171
|
+
|
|
172
|
+
:param str resource_name: The name of the resource.
|
|
173
|
+
:param CollectionFieldArgs args: The arguments to use to populate this resource's properties.
|
|
174
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
175
|
+
"""
|
|
176
|
+
...
|
|
177
|
+
def __init__(__self__, resource_name: str, *args, **kwargs):
|
|
178
|
+
resource_args, opts = _utilities.get_resource_args_opts(CollectionFieldArgs, pulumi.ResourceOptions, *args, **kwargs)
|
|
179
|
+
if resource_args is not None:
|
|
180
|
+
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
|
181
|
+
else:
|
|
182
|
+
__self__._internal_init(resource_name, *args, **kwargs)
|
|
183
|
+
|
|
184
|
+
def _internal_init(__self__,
|
|
185
|
+
resource_name: str,
|
|
186
|
+
opts: Optional[pulumi.ResourceOptions] = None,
|
|
187
|
+
collection_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
188
|
+
display_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
189
|
+
help_text: Optional[pulumi.Input[_builtins.str]] = None,
|
|
190
|
+
is_required: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
191
|
+
slug: Optional[pulumi.Input[_builtins.str]] = None,
|
|
192
|
+
type: Optional[pulumi.Input[_builtins.str]] = None,
|
|
193
|
+
validations: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
|
194
|
+
__props__=None):
|
|
195
|
+
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
196
|
+
if not isinstance(opts, pulumi.ResourceOptions):
|
|
197
|
+
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
|
198
|
+
if opts.id is None:
|
|
199
|
+
if __props__ is not None:
|
|
200
|
+
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
|
201
|
+
__props__ = CollectionFieldArgs.__new__(CollectionFieldArgs)
|
|
202
|
+
|
|
203
|
+
if collection_id is None and not opts.urn:
|
|
204
|
+
raise TypeError("Missing required property 'collection_id'")
|
|
205
|
+
__props__.__dict__["collection_id"] = collection_id
|
|
206
|
+
if display_name is None and not opts.urn:
|
|
207
|
+
raise TypeError("Missing required property 'display_name'")
|
|
208
|
+
__props__.__dict__["display_name"] = display_name
|
|
209
|
+
__props__.__dict__["help_text"] = help_text
|
|
210
|
+
__props__.__dict__["is_required"] = is_required
|
|
211
|
+
__props__.__dict__["slug"] = slug
|
|
212
|
+
if type is None and not opts.urn:
|
|
213
|
+
raise TypeError("Missing required property 'type'")
|
|
214
|
+
__props__.__dict__["type"] = type
|
|
215
|
+
__props__.__dict__["validations"] = validations
|
|
216
|
+
__props__.__dict__["field_id"] = None
|
|
217
|
+
__props__.__dict__["is_editable"] = None
|
|
218
|
+
super(CollectionField, __self__).__init__(
|
|
219
|
+
'webflow:index:CollectionField',
|
|
220
|
+
resource_name,
|
|
221
|
+
__props__,
|
|
222
|
+
opts)
|
|
223
|
+
|
|
224
|
+
@staticmethod
|
|
225
|
+
def get(resource_name: str,
|
|
226
|
+
id: pulumi.Input[str],
|
|
227
|
+
opts: Optional[pulumi.ResourceOptions] = None) -> 'CollectionField':
|
|
228
|
+
"""
|
|
229
|
+
Get an existing CollectionField resource's state with the given name, id, and optional extra
|
|
230
|
+
properties used to qualify the lookup.
|
|
231
|
+
|
|
232
|
+
:param str resource_name: The unique name of the resulting resource.
|
|
233
|
+
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
234
|
+
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
235
|
+
"""
|
|
236
|
+
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
237
|
+
|
|
238
|
+
__props__ = CollectionFieldArgs.__new__(CollectionFieldArgs)
|
|
239
|
+
|
|
240
|
+
__props__.__dict__["collection_id"] = None
|
|
241
|
+
__props__.__dict__["display_name"] = None
|
|
242
|
+
__props__.__dict__["field_id"] = None
|
|
243
|
+
__props__.__dict__["help_text"] = None
|
|
244
|
+
__props__.__dict__["is_editable"] = None
|
|
245
|
+
__props__.__dict__["is_required"] = None
|
|
246
|
+
__props__.__dict__["slug"] = None
|
|
247
|
+
__props__.__dict__["type"] = None
|
|
248
|
+
__props__.__dict__["validations"] = None
|
|
249
|
+
return CollectionField(resource_name, opts=opts, __props__=__props__)
|
|
250
|
+
|
|
251
|
+
@_builtins.property
|
|
252
|
+
@pulumi.getter(name="collectionId")
|
|
253
|
+
def collection_id(self) -> pulumi.Output[_builtins.str]:
|
|
254
|
+
"""
|
|
255
|
+
The Webflow collection ID (24-character lowercase hexadecimal string, e.g., '5f0c8c9e1c9d440000e8d8c3'). You can find collection IDs via the Webflow API or dashboard. This field will be validated before making any API calls.
|
|
256
|
+
"""
|
|
257
|
+
return pulumi.get(self, "collection_id")
|
|
258
|
+
|
|
259
|
+
@_builtins.property
|
|
260
|
+
@pulumi.getter(name="displayName")
|
|
261
|
+
def display_name(self) -> pulumi.Output[_builtins.str]:
|
|
262
|
+
"""
|
|
263
|
+
The human-readable name of the field (e.g., 'Title', 'Description', 'Author'). This name appears in the Webflow CMS interface. Maximum length: 255 characters.
|
|
264
|
+
"""
|
|
265
|
+
return pulumi.get(self, "display_name")
|
|
266
|
+
|
|
267
|
+
@_builtins.property
|
|
268
|
+
@pulumi.getter(name="fieldId")
|
|
269
|
+
def field_id(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
270
|
+
"""
|
|
271
|
+
The Webflow-assigned field ID (read-only). This ID is automatically generated when the field is created.
|
|
272
|
+
"""
|
|
273
|
+
return pulumi.get(self, "field_id")
|
|
274
|
+
|
|
275
|
+
@_builtins.property
|
|
276
|
+
@pulumi.getter(name="helpText")
|
|
277
|
+
def help_text(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
278
|
+
"""
|
|
279
|
+
Optional help text shown in the CMS interface (e.g., 'Enter the article title'). Helps content editors understand what to enter in this field.
|
|
280
|
+
"""
|
|
281
|
+
return pulumi.get(self, "help_text")
|
|
282
|
+
|
|
283
|
+
@_builtins.property
|
|
284
|
+
@pulumi.getter(name="isEditable")
|
|
285
|
+
def is_editable(self) -> pulumi.Output[Optional[_builtins.bool]]:
|
|
286
|
+
"""
|
|
287
|
+
Whether the field can be edited (read-only). System fields may not be editable.
|
|
288
|
+
"""
|
|
289
|
+
return pulumi.get(self, "is_editable")
|
|
290
|
+
|
|
291
|
+
@_builtins.property
|
|
292
|
+
@pulumi.getter(name="isRequired")
|
|
293
|
+
def is_required(self) -> pulumi.Output[Optional[_builtins.bool]]:
|
|
294
|
+
"""
|
|
295
|
+
Whether the field is required (optional, defaults to false). When true, content items must provide a value for this field.
|
|
296
|
+
"""
|
|
297
|
+
return pulumi.get(self, "is_required")
|
|
298
|
+
|
|
299
|
+
@_builtins.property
|
|
300
|
+
@pulumi.getter
|
|
301
|
+
def slug(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
302
|
+
"""
|
|
303
|
+
The URL-friendly slug for the field (optional, e.g., 'title', 'description'). If not provided, Webflow will auto-generate a slug from the displayName. The slug is used in API requests and exports.
|
|
304
|
+
"""
|
|
305
|
+
return pulumi.get(self, "slug")
|
|
306
|
+
|
|
307
|
+
@_builtins.property
|
|
308
|
+
@pulumi.getter
|
|
309
|
+
def type(self) -> pulumi.Output[_builtins.str]:
|
|
310
|
+
"""
|
|
311
|
+
The field type (e.g., 'PlainText', 'RichText', 'Image', 'Number'). Supported types: PlainText, RichText, Image, MultiImage, Video, Link, Email, Phone, Number, DateTime, Switch, Color, Option, File, Reference, MultiReference. IMPORTANT: Cannot be changed after creation - changing this requires replacement.
|
|
312
|
+
"""
|
|
313
|
+
return pulumi.get(self, "type")
|
|
314
|
+
|
|
315
|
+
@_builtins.property
|
|
316
|
+
@pulumi.getter
|
|
317
|
+
def validations(self) -> pulumi.Output[Optional[Mapping[str, Any]]]:
|
|
318
|
+
"""
|
|
319
|
+
Type-specific validation rules (optional). Different field types support different validations. Example for Number type: {"min": 0, "max": 100}. Example for PlainText type: {"maxLength": 500}. Refer to Webflow API documentation for validation options for each field type.
|
|
320
|
+
"""
|
|
321
|
+
return pulumi.get(self, "validations")
|
|
322
|
+
|