|
| 1 | +# coding=utf-8 |
| 2 | +# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. *** |
| 3 | +# *** Do not edit by hand unless you're certain you know what you are doing! *** |
| 4 | + |
| 5 | +import copy |
| 6 | +import warnings |
| 7 | +import pulumi |
| 8 | +import pulumi.runtime |
| 9 | +from typing import Any, Mapping, Optional, Sequence, Union, overload |
| 10 | +from .. import _utilities |
| 11 | +from . import outputs |
| 12 | +from ._inputs import * |
| 13 | + |
| 14 | +__all__ = ['GroupArgs', 'Group'] |
| 15 | + |
| 16 | +@pulumi.input_type |
| 17 | +class GroupArgs: |
| 18 | + def __init__(__self__, *, |
| 19 | + filter_expression: pulumi.Input[str], |
| 20 | + group_name: pulumi.Input[str], |
| 21 | + insights_configuration: Optional[pulumi.Input['GroupInsightsConfigurationArgs']] = None, |
| 22 | + tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None): |
| 23 | + """ |
| 24 | + The set of arguments for constructing a Group resource. |
| 25 | + :param pulumi.Input[str] filter_expression: The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 26 | + :param pulumi.Input[str] group_name: The name of the group. |
| 27 | + :param pulumi.Input['GroupInsightsConfigurationArgs'] insights_configuration: Configuration options for enabling insights. |
| 28 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value mapping 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 |
| 29 | + """ |
| 30 | + pulumi.set(__self__, "filter_expression", filter_expression) |
| 31 | + pulumi.set(__self__, "group_name", group_name) |
| 32 | + if insights_configuration is not None: |
| 33 | + pulumi.set(__self__, "insights_configuration", insights_configuration) |
| 34 | + if tags is not None: |
| 35 | + pulumi.set(__self__, "tags", tags) |
| 36 | + |
| 37 | + @property |
| 38 | + @pulumi.getter(name="filterExpression") |
| 39 | + def filter_expression(self) -> pulumi.Input[str]: |
| 40 | + """ |
| 41 | + The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 42 | + """ |
| 43 | + return pulumi.get(self, "filter_expression") |
| 44 | + |
| 45 | + @filter_expression.setter |
| 46 | + def filter_expression(self, value: pulumi.Input[str]): |
| 47 | + pulumi.set(self, "filter_expression", value) |
| 48 | + |
| 49 | + @property |
| 50 | + @pulumi.getter(name="groupName") |
| 51 | + def group_name(self) -> pulumi.Input[str]: |
| 52 | + """ |
| 53 | + The name of the group. |
| 54 | + """ |
| 55 | + return pulumi.get(self, "group_name") |
| 56 | + |
| 57 | + @group_name.setter |
| 58 | + def group_name(self, value: pulumi.Input[str]): |
| 59 | + pulumi.set(self, "group_name", value) |
| 60 | + |
| 61 | + @property |
| 62 | + @pulumi.getter(name="insightsConfiguration") |
| 63 | + def insights_configuration(self) -> Optional[pulumi.Input['GroupInsightsConfigurationArgs']]: |
| 64 | + """ |
| 65 | + Configuration options for enabling insights. |
| 66 | + """ |
| 67 | + return pulumi.get(self, "insights_configuration") |
| 68 | + |
| 69 | + @insights_configuration.setter |
| 70 | + def insights_configuration(self, value: Optional[pulumi.Input['GroupInsightsConfigurationArgs']]): |
| 71 | + pulumi.set(self, "insights_configuration", value) |
| 72 | + |
| 73 | + @property |
| 74 | + @pulumi.getter |
| 75 | + def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]: |
| 76 | + """ |
| 77 | + Key-value mapping 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 |
| 78 | + """ |
| 79 | + return pulumi.get(self, "tags") |
| 80 | + |
| 81 | + @tags.setter |
| 82 | + def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]): |
| 83 | + pulumi.set(self, "tags", value) |
| 84 | + |
| 85 | + |
| 86 | +@pulumi.input_type |
| 87 | +class _GroupState: |
| 88 | + def __init__(__self__, *, |
| 89 | + arn: Optional[pulumi.Input[str]] = None, |
| 90 | + filter_expression: Optional[pulumi.Input[str]] = None, |
| 91 | + group_name: Optional[pulumi.Input[str]] = None, |
| 92 | + insights_configuration: Optional[pulumi.Input['GroupInsightsConfigurationArgs']] = None, |
| 93 | + tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None, |
| 94 | + tags_all: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None): |
| 95 | + """ |
| 96 | + Input properties used for looking up and filtering Group resources. |
| 97 | + :param pulumi.Input[str] arn: The ARN of the Group. |
| 98 | + :param pulumi.Input[str] filter_expression: The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 99 | + :param pulumi.Input[str] group_name: The name of the group. |
| 100 | + :param pulumi.Input['GroupInsightsConfigurationArgs'] insights_configuration: Configuration options for enabling insights. |
| 101 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value mapping 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 |
| 102 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags_all: A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. |
| 103 | + """ |
| 104 | + if arn is not None: |
| 105 | + pulumi.set(__self__, "arn", arn) |
| 106 | + if filter_expression is not None: |
| 107 | + pulumi.set(__self__, "filter_expression", filter_expression) |
| 108 | + if group_name is not None: |
| 109 | + pulumi.set(__self__, "group_name", group_name) |
| 110 | + if insights_configuration is not None: |
| 111 | + pulumi.set(__self__, "insights_configuration", insights_configuration) |
| 112 | + if tags is not None: |
| 113 | + pulumi.set(__self__, "tags", tags) |
| 114 | + if tags_all is not None: |
| 115 | + pulumi.set(__self__, "tags_all", tags_all) |
| 116 | + |
| 117 | + @property |
| 118 | + @pulumi.getter |
| 119 | + def arn(self) -> Optional[pulumi.Input[str]]: |
| 120 | + """ |
| 121 | + The ARN of the Group. |
| 122 | + """ |
| 123 | + return pulumi.get(self, "arn") |
| 124 | + |
| 125 | + @arn.setter |
| 126 | + def arn(self, value: Optional[pulumi.Input[str]]): |
| 127 | + pulumi.set(self, "arn", value) |
| 128 | + |
| 129 | + @property |
| 130 | + @pulumi.getter(name="filterExpression") |
| 131 | + def filter_expression(self) -> Optional[pulumi.Input[str]]: |
| 132 | + """ |
| 133 | + The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 134 | + """ |
| 135 | + return pulumi.get(self, "filter_expression") |
| 136 | + |
| 137 | + @filter_expression.setter |
| 138 | + def filter_expression(self, value: Optional[pulumi.Input[str]]): |
| 139 | + pulumi.set(self, "filter_expression", value) |
| 140 | + |
| 141 | + @property |
| 142 | + @pulumi.getter(name="groupName") |
| 143 | + def group_name(self) -> Optional[pulumi.Input[str]]: |
| 144 | + """ |
| 145 | + The name of the group. |
| 146 | + """ |
| 147 | + return pulumi.get(self, "group_name") |
| 148 | + |
| 149 | + @group_name.setter |
| 150 | + def group_name(self, value: Optional[pulumi.Input[str]]): |
| 151 | + pulumi.set(self, "group_name", value) |
| 152 | + |
| 153 | + @property |
| 154 | + @pulumi.getter(name="insightsConfiguration") |
| 155 | + def insights_configuration(self) -> Optional[pulumi.Input['GroupInsightsConfigurationArgs']]: |
| 156 | + """ |
| 157 | + Configuration options for enabling insights. |
| 158 | + """ |
| 159 | + return pulumi.get(self, "insights_configuration") |
| 160 | + |
| 161 | + @insights_configuration.setter |
| 162 | + def insights_configuration(self, value: Optional[pulumi.Input['GroupInsightsConfigurationArgs']]): |
| 163 | + pulumi.set(self, "insights_configuration", value) |
| 164 | + |
| 165 | + @property |
| 166 | + @pulumi.getter |
| 167 | + def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]: |
| 168 | + """ |
| 169 | + Key-value mapping 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 |
| 170 | + """ |
| 171 | + return pulumi.get(self, "tags") |
| 172 | + |
| 173 | + @tags.setter |
| 174 | + def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]): |
| 175 | + pulumi.set(self, "tags", value) |
| 176 | + |
| 177 | + @property |
| 178 | + @pulumi.getter(name="tagsAll") |
| 179 | + def tags_all(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]: |
| 180 | + """ |
| 181 | + A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. |
| 182 | + """ |
| 183 | + return pulumi.get(self, "tags_all") |
| 184 | + |
| 185 | + @tags_all.setter |
| 186 | + def tags_all(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]): |
| 187 | + pulumi.set(self, "tags_all", value) |
| 188 | + |
| 189 | + |
| 190 | +class Group(pulumi.CustomResource): |
| 191 | + @overload |
| 192 | + def __init__(__self__, |
| 193 | + resource_name: str, |
| 194 | + opts: Optional[pulumi.ResourceOptions] = None, |
| 195 | + filter_expression: Optional[pulumi.Input[str]] = None, |
| 196 | + group_name: Optional[pulumi.Input[str]] = None, |
| 197 | + insights_configuration: Optional[pulumi.Input[pulumi.InputType['GroupInsightsConfigurationArgs']]] = None, |
| 198 | + tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None, |
| 199 | + __props__=None): |
| 200 | + """ |
| 201 | + Creates and manages an AWS XRay Group. |
| 202 | +
|
| 203 | + ## Example Usage |
| 204 | +
|
| 205 | + ```python |
| 206 | + import pulumi |
| 207 | + import pulumi_aws as aws |
| 208 | +
|
| 209 | + example = aws.xray.Group("example", |
| 210 | + filter_expression="responsetime > 5", |
| 211 | + group_name="example", |
| 212 | + insights_configuration=aws.xray.GroupInsightsConfigurationArgs( |
| 213 | + insights_enabled=True, |
| 214 | + notifications_enabled=True, |
| 215 | + )) |
| 216 | + ``` |
| 217 | +
|
| 218 | + ## Import |
| 219 | +
|
| 220 | + XRay Groups can be imported using the ARN, e.g., |
| 221 | +
|
| 222 | + ```sh |
| 223 | + $ pulumi import aws:xray/group:Group example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA |
| 224 | + ``` |
| 225 | +
|
| 226 | + :param str resource_name: The name of the resource. |
| 227 | + :param pulumi.ResourceOptions opts: Options for the resource. |
| 228 | + :param pulumi.Input[str] filter_expression: The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 229 | + :param pulumi.Input[str] group_name: The name of the group. |
| 230 | + :param pulumi.Input[pulumi.InputType['GroupInsightsConfigurationArgs']] insights_configuration: Configuration options for enabling insights. |
| 231 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value mapping 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 |
| 232 | + """ |
| 233 | + ... |
| 234 | + @overload |
| 235 | + def __init__(__self__, |
| 236 | + resource_name: str, |
| 237 | + args: GroupArgs, |
| 238 | + opts: Optional[pulumi.ResourceOptions] = None): |
| 239 | + """ |
| 240 | + Creates and manages an AWS XRay Group. |
| 241 | +
|
| 242 | + ## Example Usage |
| 243 | +
|
| 244 | + ```python |
| 245 | + import pulumi |
| 246 | + import pulumi_aws as aws |
| 247 | +
|
| 248 | + example = aws.xray.Group("example", |
| 249 | + filter_expression="responsetime > 5", |
| 250 | + group_name="example", |
| 251 | + insights_configuration=aws.xray.GroupInsightsConfigurationArgs( |
| 252 | + insights_enabled=True, |
| 253 | + notifications_enabled=True, |
| 254 | + )) |
| 255 | + ``` |
| 256 | +
|
| 257 | + ## Import |
| 258 | +
|
| 259 | + XRay Groups can be imported using the ARN, e.g., |
| 260 | +
|
| 261 | + ```sh |
| 262 | + $ pulumi import aws:xray/group:Group example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA |
| 263 | + ``` |
| 264 | +
|
| 265 | + :param str resource_name: The name of the resource. |
| 266 | + :param GroupArgs args: The arguments to use to populate this resource's properties. |
| 267 | + :param pulumi.ResourceOptions opts: Options for the resource. |
| 268 | + """ |
| 269 | + ... |
| 270 | + def __init__(__self__, resource_name: str, *args, **kwargs): |
| 271 | + resource_args, opts = _utilities.get_resource_args_opts(GroupArgs, pulumi.ResourceOptions, *args, **kwargs) |
| 272 | + if resource_args is not None: |
| 273 | + __self__._internal_init(resource_name, opts, **resource_args.__dict__) |
| 274 | + else: |
| 275 | + __self__._internal_init(resource_name, *args, **kwargs) |
| 276 | + |
| 277 | + def _internal_init(__self__, |
| 278 | + resource_name: str, |
| 279 | + opts: Optional[pulumi.ResourceOptions] = None, |
| 280 | + filter_expression: Optional[pulumi.Input[str]] = None, |
| 281 | + group_name: Optional[pulumi.Input[str]] = None, |
| 282 | + insights_configuration: Optional[pulumi.Input[pulumi.InputType['GroupInsightsConfigurationArgs']]] = None, |
| 283 | + tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None, |
| 284 | + __props__=None): |
| 285 | + opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) |
| 286 | + if not isinstance(opts, pulumi.ResourceOptions): |
| 287 | + raise TypeError('Expected resource options to be a ResourceOptions instance') |
| 288 | + if opts.id is None: |
| 289 | + if __props__ is not None: |
| 290 | + raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') |
| 291 | + __props__ = GroupArgs.__new__(GroupArgs) |
| 292 | + |
| 293 | + if filter_expression is None and not opts.urn: |
| 294 | + raise TypeError("Missing required property 'filter_expression'") |
| 295 | + __props__.__dict__["filter_expression"] = filter_expression |
| 296 | + if group_name is None and not opts.urn: |
| 297 | + raise TypeError("Missing required property 'group_name'") |
| 298 | + __props__.__dict__["group_name"] = group_name |
| 299 | + __props__.__dict__["insights_configuration"] = insights_configuration |
| 300 | + __props__.__dict__["tags"] = tags |
| 301 | + __props__.__dict__["arn"] = None |
| 302 | + __props__.__dict__["tags_all"] = None |
| 303 | + super(Group, __self__).__init__( |
| 304 | + 'aws:xray/group:Group', |
| 305 | + resource_name, |
| 306 | + __props__, |
| 307 | + opts) |
| 308 | + |
| 309 | + @staticmethod |
| 310 | + def get(resource_name: str, |
| 311 | + id: pulumi.Input[str], |
| 312 | + opts: Optional[pulumi.ResourceOptions] = None, |
| 313 | + arn: Optional[pulumi.Input[str]] = None, |
| 314 | + filter_expression: Optional[pulumi.Input[str]] = None, |
| 315 | + group_name: Optional[pulumi.Input[str]] = None, |
| 316 | + insights_configuration: Optional[pulumi.Input[pulumi.InputType['GroupInsightsConfigurationArgs']]] = None, |
| 317 | + tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None, |
| 318 | + tags_all: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None) -> 'Group': |
| 319 | + """ |
| 320 | + Get an existing Group resource's state with the given name, id, and optional extra |
| 321 | + properties used to qualify the lookup. |
| 322 | +
|
| 323 | + :param str resource_name: The unique name of the resulting resource. |
| 324 | + :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. |
| 325 | + :param pulumi.ResourceOptions opts: Options for the resource. |
| 326 | + :param pulumi.Input[str] arn: The ARN of the Group. |
| 327 | + :param pulumi.Input[str] filter_expression: The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 328 | + :param pulumi.Input[str] group_name: The name of the group. |
| 329 | + :param pulumi.Input[pulumi.InputType['GroupInsightsConfigurationArgs']] insights_configuration: Configuration options for enabling insights. |
| 330 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: Key-value mapping 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 |
| 331 | + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags_all: A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. |
| 332 | + """ |
| 333 | + opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) |
| 334 | + |
| 335 | + __props__ = _GroupState.__new__(_GroupState) |
| 336 | + |
| 337 | + __props__.__dict__["arn"] = arn |
| 338 | + __props__.__dict__["filter_expression"] = filter_expression |
| 339 | + __props__.__dict__["group_name"] = group_name |
| 340 | + __props__.__dict__["insights_configuration"] = insights_configuration |
| 341 | + __props__.__dict__["tags"] = tags |
| 342 | + __props__.__dict__["tags_all"] = tags_all |
| 343 | + return Group(resource_name, opts=opts, __props__=__props__) |
| 344 | + |
| 345 | + @property |
| 346 | + @pulumi.getter |
| 347 | + def arn(self) -> pulumi.Output[str]: |
| 348 | + """ |
| 349 | + The ARN of the Group. |
| 350 | + """ |
| 351 | + return pulumi.get(self, "arn") |
| 352 | + |
| 353 | + @property |
| 354 | + @pulumi.getter(name="filterExpression") |
| 355 | + def filter_expression(self) -> pulumi.Output[str]: |
| 356 | + """ |
| 357 | + The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). |
| 358 | + """ |
| 359 | + return pulumi.get(self, "filter_expression") |
| 360 | + |
| 361 | + @property |
| 362 | + @pulumi.getter(name="groupName") |
| 363 | + def group_name(self) -> pulumi.Output[str]: |
| 364 | + """ |
| 365 | + The name of the group. |
| 366 | + """ |
| 367 | + return pulumi.get(self, "group_name") |
| 368 | + |
| 369 | + @property |
| 370 | + @pulumi.getter(name="insightsConfiguration") |
| 371 | + def insights_configuration(self) -> pulumi.Output['outputs.GroupInsightsConfiguration']: |
| 372 | + """ |
| 373 | + Configuration options for enabling insights. |
| 374 | + """ |
| 375 | + return pulumi.get(self, "insights_configuration") |
| 376 | + |
| 377 | + @property |
| 378 | + @pulumi.getter |
| 379 | + def tags(self) -> pulumi.Output[Optional[Mapping[str, str]]]: |
| 380 | + """ |
| 381 | + Key-value mapping 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 |
| 382 | + """ |
| 383 | + return pulumi.get(self, "tags") |
| 384 | + |
| 385 | + @property |
| 386 | + @pulumi.getter(name="tagsAll") |
| 387 | + def tags_all(self) -> pulumi.Output[Mapping[str, str]]: |
| 388 | + """ |
| 389 | + A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. |
| 390 | + """ |
| 391 | + return pulumi.get(self, "tags_all") |
| 392 | + |
0 commit comments