Documentation ¶
Index ¶
- type EncryptionConfig
- type EncryptionConfigArgs
- type EncryptionConfigInput
- type EncryptionConfigOutput
- type EncryptionConfigState
- type Group
- type GroupArgs
- type GroupInput
- type GroupOutput
- type GroupState
- type SamplingRule
- type SamplingRuleArgs
- type SamplingRuleInput
- type SamplingRuleOutput
- type SamplingRuleState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EncryptionConfig ¶ added in v3.3.0
type EncryptionConfig struct { pulumi.CustomResourceState // An AWS KMS customer master key (CMK) ARN. KeyId pulumi.StringPtrOutput `pulumi:"keyId"` // The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption. Type pulumi.StringOutput `pulumi:"type"` }
## Import
XRay Encryption Config can be imported using the region name, e.g.
```sh
$ pulumi import aws:xray/encryptionConfig:EncryptionConfig example us-west-2
```
func GetEncryptionConfig ¶ added in v3.3.0
func GetEncryptionConfig(ctx *pulumi.Context, name string, id pulumi.IDInput, state *EncryptionConfigState, opts ...pulumi.ResourceOption) (*EncryptionConfig, error)
GetEncryptionConfig gets an existing EncryptionConfig resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewEncryptionConfig ¶ added in v3.3.0
func NewEncryptionConfig(ctx *pulumi.Context, name string, args *EncryptionConfigArgs, opts ...pulumi.ResourceOption) (*EncryptionConfig, error)
NewEncryptionConfig registers a new resource with the given unique name, arguments, and options.
func (EncryptionConfig) ElementType ¶ added in v3.13.0
func (EncryptionConfig) ElementType() reflect.Type
func (EncryptionConfig) ToEncryptionConfigOutput ¶ added in v3.13.0
func (i EncryptionConfig) ToEncryptionConfigOutput() EncryptionConfigOutput
func (EncryptionConfig) ToEncryptionConfigOutputWithContext ¶ added in v3.13.0
func (i EncryptionConfig) ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput
type EncryptionConfigArgs ¶ added in v3.3.0
type EncryptionConfigArgs struct { // An AWS KMS customer master key (CMK) ARN. KeyId pulumi.StringPtrInput // The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption. Type pulumi.StringInput }
The set of arguments for constructing a EncryptionConfig resource.
func (EncryptionConfigArgs) ElementType ¶ added in v3.3.0
func (EncryptionConfigArgs) ElementType() reflect.Type
type EncryptionConfigInput ¶ added in v3.13.0
type EncryptionConfigInput interface { pulumi.Input ToEncryptionConfigOutput() EncryptionConfigOutput ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput }
type EncryptionConfigOutput ¶ added in v3.13.0
type EncryptionConfigOutput struct {
*pulumi.OutputState
}
func (EncryptionConfigOutput) ElementType ¶ added in v3.13.0
func (EncryptionConfigOutput) ElementType() reflect.Type
func (EncryptionConfigOutput) ToEncryptionConfigOutput ¶ added in v3.13.0
func (o EncryptionConfigOutput) ToEncryptionConfigOutput() EncryptionConfigOutput
func (EncryptionConfigOutput) ToEncryptionConfigOutputWithContext ¶ added in v3.13.0
func (o EncryptionConfigOutput) ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput
type EncryptionConfigState ¶ added in v3.3.0
type EncryptionConfigState struct { // An AWS KMS customer master key (CMK) ARN. KeyId pulumi.StringPtrInput // The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption. Type pulumi.StringPtrInput }
func (EncryptionConfigState) ElementType ¶ added in v3.3.0
func (EncryptionConfigState) ElementType() reflect.Type
type Group ¶ added in v3.3.0
type Group struct { pulumi.CustomResourceState // The ARN of the Group. Arn pulumi.StringOutput `pulumi:"arn"` // 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). FilterExpression pulumi.StringOutput `pulumi:"filterExpression"` // The name of the group. GroupName pulumi.StringOutput `pulumi:"groupName"` // Key-value mapping of resource tags Tags pulumi.StringMapOutput `pulumi:"tags"` }
Creates and manages an AWS XRay Group.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/xray" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := xray.NewGroup(ctx, "example", &xray.GroupArgs{ FilterExpression: pulumi.String("responsetime > 5"), GroupName: pulumi.String("example"), }) if err != nil { return err } return nil }) }
```
## Import
XRay Groups can be imported using the ARN, e.g.
```sh
$ pulumi import aws:xray/group:Group example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA
```
func GetGroup ¶ added in v3.3.0
func GetGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)
GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewGroup ¶ added in v3.3.0
func NewGroup(ctx *pulumi.Context, name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)
NewGroup registers a new resource with the given unique name, arguments, and options.
func (Group) ElementType ¶ added in v3.13.0
func (Group) ToGroupOutput ¶ added in v3.13.0
func (i Group) ToGroupOutput() GroupOutput
func (Group) ToGroupOutputWithContext ¶ added in v3.13.0
func (i Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput
type GroupArgs ¶ added in v3.3.0
type GroupArgs struct { // 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). FilterExpression pulumi.StringInput // The name of the group. GroupName pulumi.StringInput // Key-value mapping of resource tags Tags pulumi.StringMapInput }
The set of arguments for constructing a Group resource.
func (GroupArgs) ElementType ¶ added in v3.3.0
type GroupInput ¶ added in v3.13.0
type GroupInput interface { pulumi.Input ToGroupOutput() GroupOutput ToGroupOutputWithContext(ctx context.Context) GroupOutput }
type GroupOutput ¶ added in v3.13.0
type GroupOutput struct {
*pulumi.OutputState
}
func (GroupOutput) ElementType ¶ added in v3.13.0
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) ToGroupOutput ¶ added in v3.13.0
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶ added in v3.13.0
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
type GroupState ¶ added in v3.3.0
type GroupState struct { // The ARN of the Group. Arn pulumi.StringPtrInput // 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). FilterExpression pulumi.StringPtrInput // The name of the group. GroupName pulumi.StringPtrInput // Key-value mapping of resource tags Tags pulumi.StringMapInput }
func (GroupState) ElementType ¶ added in v3.3.0
func (GroupState) ElementType() reflect.Type
type SamplingRule ¶
type SamplingRule struct { pulumi.CustomResourceState // The ARN of the sampling rule. Arn pulumi.StringOutput `pulumi:"arn"` // Matches attributes derived from the request. Attributes pulumi.StringMapOutput `pulumi:"attributes"` // The percentage of matching requests to instrument, after the reservoir is exhausted. FixedRate pulumi.Float64Output `pulumi:"fixedRate"` // Matches the hostname from a request URL. Host pulumi.StringOutput `pulumi:"host"` // Matches the HTTP method of a request. HttpMethod pulumi.StringOutput `pulumi:"httpMethod"` // The priority of the sampling rule. Priority pulumi.IntOutput `pulumi:"priority"` // A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. ReservoirSize pulumi.IntOutput `pulumi:"reservoirSize"` // Matches the ARN of the AWS resource on which the service runs. ResourceArn pulumi.StringOutput `pulumi:"resourceArn"` // The name of the sampling rule. RuleName pulumi.StringPtrOutput `pulumi:"ruleName"` // Matches the `name` that the service uses to identify itself in segments. ServiceName pulumi.StringOutput `pulumi:"serviceName"` // Matches the `origin` that the service uses to identify its type in segments. ServiceType pulumi.StringOutput `pulumi:"serviceType"` // Key-value mapping of resource tags Tags pulumi.StringMapOutput `pulumi:"tags"` // Matches the path from a request URL. UrlPath pulumi.StringOutput `pulumi:"urlPath"` // The version of the sampling rule format (`1` ) Version pulumi.IntOutput `pulumi:"version"` }
Creates and manages an AWS XRay Sampling Rule.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/xray" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := xray.NewSamplingRule(ctx, "example", &xray.SamplingRuleArgs{ Attributes: pulumi.StringMap{ "Hello": pulumi.String("Tris"), }, FixedRate: pulumi.Float64(0.05), Host: pulumi.String("*"), HttpMethod: pulumi.String("*"), Priority: pulumi.Int(10000), ReservoirSize: pulumi.Int(1), ResourceArn: pulumi.String("*"), RuleName: pulumi.String("example"), ServiceName: pulumi.String("*"), ServiceType: pulumi.String("*"), UrlPath: pulumi.String("*"), Version: pulumi.Int(1), }) if err != nil { return err } return nil }) }
```
## Import
XRay Sampling Rules can be imported using the name, e.g.
```sh
$ pulumi import aws:xray/samplingRule:SamplingRule example example
```
func GetSamplingRule ¶
func GetSamplingRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SamplingRuleState, opts ...pulumi.ResourceOption) (*SamplingRule, error)
GetSamplingRule gets an existing SamplingRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSamplingRule ¶
func NewSamplingRule(ctx *pulumi.Context, name string, args *SamplingRuleArgs, opts ...pulumi.ResourceOption) (*SamplingRule, error)
NewSamplingRule registers a new resource with the given unique name, arguments, and options.
func (SamplingRule) ElementType ¶ added in v3.13.0
func (SamplingRule) ElementType() reflect.Type
func (SamplingRule) ToSamplingRuleOutput ¶ added in v3.13.0
func (i SamplingRule) ToSamplingRuleOutput() SamplingRuleOutput
func (SamplingRule) ToSamplingRuleOutputWithContext ¶ added in v3.13.0
func (i SamplingRule) ToSamplingRuleOutputWithContext(ctx context.Context) SamplingRuleOutput
type SamplingRuleArgs ¶
type SamplingRuleArgs struct { // Matches attributes derived from the request. Attributes pulumi.StringMapInput // The percentage of matching requests to instrument, after the reservoir is exhausted. FixedRate pulumi.Float64Input // Matches the hostname from a request URL. Host pulumi.StringInput // Matches the HTTP method of a request. HttpMethod pulumi.StringInput // The priority of the sampling rule. Priority pulumi.IntInput // A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. ReservoirSize pulumi.IntInput // Matches the ARN of the AWS resource on which the service runs. ResourceArn pulumi.StringInput // The name of the sampling rule. RuleName pulumi.StringPtrInput // Matches the `name` that the service uses to identify itself in segments. ServiceName pulumi.StringInput // Matches the `origin` that the service uses to identify its type in segments. ServiceType pulumi.StringInput // Key-value mapping of resource tags Tags pulumi.StringMapInput // Matches the path from a request URL. UrlPath pulumi.StringInput // The version of the sampling rule format (`1` ) Version pulumi.IntInput }
The set of arguments for constructing a SamplingRule resource.
func (SamplingRuleArgs) ElementType ¶
func (SamplingRuleArgs) ElementType() reflect.Type
type SamplingRuleInput ¶ added in v3.13.0
type SamplingRuleInput interface { pulumi.Input ToSamplingRuleOutput() SamplingRuleOutput ToSamplingRuleOutputWithContext(ctx context.Context) SamplingRuleOutput }
type SamplingRuleOutput ¶ added in v3.13.0
type SamplingRuleOutput struct {
*pulumi.OutputState
}
func (SamplingRuleOutput) ElementType ¶ added in v3.13.0
func (SamplingRuleOutput) ElementType() reflect.Type
func (SamplingRuleOutput) ToSamplingRuleOutput ¶ added in v3.13.0
func (o SamplingRuleOutput) ToSamplingRuleOutput() SamplingRuleOutput
func (SamplingRuleOutput) ToSamplingRuleOutputWithContext ¶ added in v3.13.0
func (o SamplingRuleOutput) ToSamplingRuleOutputWithContext(ctx context.Context) SamplingRuleOutput
type SamplingRuleState ¶
type SamplingRuleState struct { // The ARN of the sampling rule. Arn pulumi.StringPtrInput // Matches attributes derived from the request. Attributes pulumi.StringMapInput // The percentage of matching requests to instrument, after the reservoir is exhausted. FixedRate pulumi.Float64PtrInput // Matches the hostname from a request URL. Host pulumi.StringPtrInput // Matches the HTTP method of a request. HttpMethod pulumi.StringPtrInput // The priority of the sampling rule. Priority pulumi.IntPtrInput // A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively. ReservoirSize pulumi.IntPtrInput // Matches the ARN of the AWS resource on which the service runs. ResourceArn pulumi.StringPtrInput // The name of the sampling rule. RuleName pulumi.StringPtrInput // Matches the `name` that the service uses to identify itself in segments. ServiceName pulumi.StringPtrInput // Matches the `origin` that the service uses to identify its type in segments. ServiceType pulumi.StringPtrInput // Key-value mapping of resource tags Tags pulumi.StringMapInput // Matches the path from a request URL. UrlPath pulumi.StringPtrInput // The version of the sampling rule format (`1` ) Version pulumi.IntPtrInput }
func (SamplingRuleState) ElementType ¶
func (SamplingRuleState) ElementType() reflect.Type