xray

package
v5.43.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EncryptionConfig 

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"`
}

Creates and manages an AWS XRay Encryption Config.

> **NOTE:** Removing this resource from the provider has no effect to the encryption configuration within X-Ray.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewEncryptionConfig(ctx, "example", &xray.EncryptionConfigArgs{
			Type: pulumi.String("NONE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### With KMS Key

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, nil, nil)
		if err != nil {
			return err
		}
		examplePolicyDocument, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Sid:    pulumi.StringRef("Enable IAM User Permissions"),
					Effect: pulumi.StringRef("Allow"),
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "AWS",
							Identifiers: []string{
								fmt.Sprintf("arn:aws:iam::%v:root", current.AccountId),
							},
						},
					},
					Actions: []string{
						"kms:*",
					},
					Resources: []string{
						"*",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		exampleKey, err := kms.NewKey(ctx, "exampleKey", &kms.KeyArgs{
			Description:          pulumi.String("Some Key"),
			DeletionWindowInDays: pulumi.Int(7),
			Policy:               *pulumi.String(examplePolicyDocument.Json),
		})
		if err != nil {
			return err
		}
		_, err = xray.NewEncryptionConfig(ctx, "exampleEncryptionConfig", &xray.EncryptionConfigArgs{
			Type:  pulumi.String("KMS"),
			KeyId: exampleKey.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## 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 

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 

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 

func (*EncryptionConfig) ElementType() reflect.Type

func (*EncryptionConfig) ToEncryptionConfigOutput 

func (i *EncryptionConfig) ToEncryptionConfigOutput() EncryptionConfigOutput

func (*EncryptionConfig) ToEncryptionConfigOutputWithContext 

func (i *EncryptionConfig) ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput

type EncryptionConfigArgs 

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 

func (EncryptionConfigArgs) ElementType() reflect.Type

type EncryptionConfigArray 

type EncryptionConfigArray []EncryptionConfigInput

func (EncryptionConfigArray) ElementType 

func (EncryptionConfigArray) ElementType() reflect.Type

func (EncryptionConfigArray) ToEncryptionConfigArrayOutput 

func (i EncryptionConfigArray) ToEncryptionConfigArrayOutput() EncryptionConfigArrayOutput

func (EncryptionConfigArray) ToEncryptionConfigArrayOutputWithContext 

func (i EncryptionConfigArray) ToEncryptionConfigArrayOutputWithContext(ctx context.Context) EncryptionConfigArrayOutput

type EncryptionConfigArrayInput 

type EncryptionConfigArrayInput interface {
	pulumi.Input

	ToEncryptionConfigArrayOutput() EncryptionConfigArrayOutput
	ToEncryptionConfigArrayOutputWithContext(context.Context) EncryptionConfigArrayOutput
}

EncryptionConfigArrayInput is an input type that accepts EncryptionConfigArray and EncryptionConfigArrayOutput values. You can construct a concrete instance of `EncryptionConfigArrayInput` via: 

EncryptionConfigArray{ EncryptionConfigArgs{...} }

type EncryptionConfigArrayOutput 

type EncryptionConfigArrayOutput struct{ *pulumi.OutputState }

func (EncryptionConfigArrayOutput) ElementType 

func (EncryptionConfigArrayOutput) ElementType() reflect.Type

func (EncryptionConfigArrayOutput) Index 

func (o EncryptionConfigArrayOutput) Index(i pulumi.IntInput) EncryptionConfigOutput

func (EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutput 

func (o EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutput() EncryptionConfigArrayOutput

func (EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutputWithContext 

func (o EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutputWithContext(ctx context.Context) EncryptionConfigArrayOutput

type EncryptionConfigInput 

type EncryptionConfigInput interface {
	pulumi.Input

	ToEncryptionConfigOutput() EncryptionConfigOutput
	ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput
}

type EncryptionConfigMap 

type EncryptionConfigMap map[string]EncryptionConfigInput

func (EncryptionConfigMap) ElementType 

func (EncryptionConfigMap) ElementType() reflect.Type

func (EncryptionConfigMap) ToEncryptionConfigMapOutput 

func (i EncryptionConfigMap) ToEncryptionConfigMapOutput() EncryptionConfigMapOutput

func (EncryptionConfigMap) ToEncryptionConfigMapOutputWithContext 

func (i EncryptionConfigMap) ToEncryptionConfigMapOutputWithContext(ctx context.Context) EncryptionConfigMapOutput

type EncryptionConfigMapInput 

type EncryptionConfigMapInput interface {
	pulumi.Input

	ToEncryptionConfigMapOutput() EncryptionConfigMapOutput
	ToEncryptionConfigMapOutputWithContext(context.Context) EncryptionConfigMapOutput
}

EncryptionConfigMapInput is an input type that accepts EncryptionConfigMap and EncryptionConfigMapOutput values. You can construct a concrete instance of `EncryptionConfigMapInput` via: 

EncryptionConfigMap{ "key": EncryptionConfigArgs{...} }

type EncryptionConfigMapOutput 

type EncryptionConfigMapOutput struct{ *pulumi.OutputState }

func (EncryptionConfigMapOutput) ElementType 

func (EncryptionConfigMapOutput) ElementType() reflect.Type

func (EncryptionConfigMapOutput) MapIndex 

func (o EncryptionConfigMapOutput) MapIndex(k pulumi.StringInput) EncryptionConfigOutput

func (EncryptionConfigMapOutput) ToEncryptionConfigMapOutput 

func (o EncryptionConfigMapOutput) ToEncryptionConfigMapOutput() EncryptionConfigMapOutput

func (EncryptionConfigMapOutput) ToEncryptionConfigMapOutputWithContext 

func (o EncryptionConfigMapOutput) ToEncryptionConfigMapOutputWithContext(ctx context.Context) EncryptionConfigMapOutput

type EncryptionConfigOutput 

type EncryptionConfigOutput struct{ *pulumi.OutputState }

func (EncryptionConfigOutput) ElementType 

func (EncryptionConfigOutput) ElementType() reflect.Type

func (EncryptionConfigOutput) KeyId added in v5.4.0 

func (o EncryptionConfigOutput) KeyId() pulumi.StringPtrOutput

An AWS KMS customer master key (CMK) ARN.

func (EncryptionConfigOutput) ToEncryptionConfigOutput 

func (o EncryptionConfigOutput) ToEncryptionConfigOutput() EncryptionConfigOutput

func (EncryptionConfigOutput) ToEncryptionConfigOutputWithContext 

func (o EncryptionConfigOutput) ToEncryptionConfigOutputWithContext(ctx context.Context) EncryptionConfigOutput

func (EncryptionConfigOutput) Type added in v5.4.0 

func (o EncryptionConfigOutput) Type() pulumi.StringOutput

The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption.

type EncryptionConfigState 

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 

func (EncryptionConfigState) ElementType() reflect.Type

type Group 

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"`
	// Configuration options for enabling insights.
	InsightsConfiguration GroupInsightsConfigurationOutput `pulumi:"insightsConfiguration"`
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Creates and manages an AWS XRay Group.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v3/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"),
			InsightsConfiguration: &xray.GroupInsightsConfigurationArgs{
				InsightsEnabled:      pulumi.Bool(true),
				NotificationsEnabled: pulumi.Bool(true),
			},
		})
		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 

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 

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 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs 

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
	// Configuration options for enabling insights.
	InsightsConfiguration GroupInsightsConfigurationPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType 

func (GroupArgs) ElementType() reflect.Type

type GroupArray 

type GroupArray []GroupInput

func (GroupArray) ElementType 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext 

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput 

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via: 

GroupArray{ GroupArgs{...} }

type GroupArrayOutput 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index 

func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput

func (GroupArrayOutput) ToGroupArrayOutput 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext 

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupInput 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupInsightsConfiguration added in v5.2.0 

type GroupInsightsConfiguration struct {
	// Specifies whether insights are enabled.
	InsightsEnabled bool `pulumi:"insightsEnabled"`
	// Specifies whether insight notifications are enabled.
	NotificationsEnabled *bool `pulumi:"notificationsEnabled"`
}

type GroupInsightsConfigurationArgs added in v5.2.0 

type GroupInsightsConfigurationArgs struct {
	// Specifies whether insights are enabled.
	InsightsEnabled pulumi.BoolInput `pulumi:"insightsEnabled"`
	// Specifies whether insight notifications are enabled.
	NotificationsEnabled pulumi.BoolPtrInput `pulumi:"notificationsEnabled"`
}

func (GroupInsightsConfigurationArgs) ElementType added in v5.2.0 

func (GroupInsightsConfigurationArgs) ElementType() reflect.Type

func (GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationOutput added in v5.2.0 

func (i GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationOutput() GroupInsightsConfigurationOutput

func (GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationOutputWithContext added in v5.2.0 

func (i GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationOutputWithContext(ctx context.Context) GroupInsightsConfigurationOutput

func (GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationPtrOutput added in v5.2.0 

func (i GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationPtrOutput() GroupInsightsConfigurationPtrOutput

func (GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationPtrOutputWithContext added in v5.2.0 

func (i GroupInsightsConfigurationArgs) ToGroupInsightsConfigurationPtrOutputWithContext(ctx context.Context) GroupInsightsConfigurationPtrOutput

type GroupInsightsConfigurationInput added in v5.2.0 

type GroupInsightsConfigurationInput interface {
	pulumi.Input

	ToGroupInsightsConfigurationOutput() GroupInsightsConfigurationOutput
	ToGroupInsightsConfigurationOutputWithContext(context.Context) GroupInsightsConfigurationOutput
}

GroupInsightsConfigurationInput is an input type that accepts GroupInsightsConfigurationArgs and GroupInsightsConfigurationOutput values. You can construct a concrete instance of `GroupInsightsConfigurationInput` via: 

GroupInsightsConfigurationArgs{...}

type GroupInsightsConfigurationOutput added in v5.2.0 

type GroupInsightsConfigurationOutput struct{ *pulumi.OutputState }

func (GroupInsightsConfigurationOutput) ElementType added in v5.2.0 

func (GroupInsightsConfigurationOutput) ElementType() reflect.Type

func (GroupInsightsConfigurationOutput) InsightsEnabled added in v5.2.0 

func (o GroupInsightsConfigurationOutput) InsightsEnabled() pulumi.BoolOutput

Specifies whether insights are enabled.

func (GroupInsightsConfigurationOutput) NotificationsEnabled added in v5.2.0 

func (o GroupInsightsConfigurationOutput) NotificationsEnabled() pulumi.BoolPtrOutput

Specifies whether insight notifications are enabled.

func (GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationOutput added in v5.2.0 

func (o GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationOutput() GroupInsightsConfigurationOutput

func (GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationOutputWithContext added in v5.2.0 

func (o GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationOutputWithContext(ctx context.Context) GroupInsightsConfigurationOutput

func (GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationPtrOutput added in v5.2.0 

func (o GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationPtrOutput() GroupInsightsConfigurationPtrOutput

func (GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationPtrOutputWithContext added in v5.2.0 

func (o GroupInsightsConfigurationOutput) ToGroupInsightsConfigurationPtrOutputWithContext(ctx context.Context) GroupInsightsConfigurationPtrOutput

type GroupInsightsConfigurationPtrInput added in v5.2.0 

type GroupInsightsConfigurationPtrInput interface {
	pulumi.Input

	ToGroupInsightsConfigurationPtrOutput() GroupInsightsConfigurationPtrOutput
	ToGroupInsightsConfigurationPtrOutputWithContext(context.Context) GroupInsightsConfigurationPtrOutput
}

GroupInsightsConfigurationPtrInput is an input type that accepts GroupInsightsConfigurationArgs, GroupInsightsConfigurationPtr and GroupInsightsConfigurationPtrOutput values. You can construct a concrete instance of `GroupInsightsConfigurationPtrInput` via: 

        GroupInsightsConfigurationArgs{...}

or:

        nil

func GroupInsightsConfigurationPtr added in v5.2.0 

func GroupInsightsConfigurationPtr(v *GroupInsightsConfigurationArgs) GroupInsightsConfigurationPtrInput

type GroupInsightsConfigurationPtrOutput added in v5.2.0 

type GroupInsightsConfigurationPtrOutput struct{ *pulumi.OutputState }

func (GroupInsightsConfigurationPtrOutput) Elem added in v5.2.0 

func (o GroupInsightsConfigurationPtrOutput) Elem() GroupInsightsConfigurationOutput

func (GroupInsightsConfigurationPtrOutput) ElementType added in v5.2.0 

func (GroupInsightsConfigurationPtrOutput) ElementType() reflect.Type

func (GroupInsightsConfigurationPtrOutput) InsightsEnabled added in v5.2.0 

func (o GroupInsightsConfigurationPtrOutput) InsightsEnabled() pulumi.BoolPtrOutput

Specifies whether insights are enabled.

func (GroupInsightsConfigurationPtrOutput) NotificationsEnabled added in v5.2.0 

func (o GroupInsightsConfigurationPtrOutput) NotificationsEnabled() pulumi.BoolPtrOutput

Specifies whether insight notifications are enabled.

func (GroupInsightsConfigurationPtrOutput) ToGroupInsightsConfigurationPtrOutput added in v5.2.0 

func (o GroupInsightsConfigurationPtrOutput) ToGroupInsightsConfigurationPtrOutput() GroupInsightsConfigurationPtrOutput

func (GroupInsightsConfigurationPtrOutput) ToGroupInsightsConfigurationPtrOutputWithContext added in v5.2.0 

func (o GroupInsightsConfigurationPtrOutput) ToGroupInsightsConfigurationPtrOutputWithContext(ctx context.Context) GroupInsightsConfigurationPtrOutput

type GroupMap 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext 

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput 

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via: 

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex 

func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput

func (GroupMapOutput) ToGroupMapOutput 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext 

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) Arn added in v5.4.0 

func (o GroupOutput) Arn() pulumi.StringOutput

The ARN of the Group.

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) FilterExpression added in v5.4.0 

func (o GroupOutput) FilterExpression() pulumi.StringOutput

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).

func (GroupOutput) GroupName added in v5.4.0 

func (o GroupOutput) GroupName() pulumi.StringOutput

The name of the group.

func (GroupOutput) InsightsConfiguration added in v5.4.0 

func (o GroupOutput) InsightsConfiguration() GroupInsightsConfigurationOutput

Configuration options for enabling insights.

func (GroupOutput) Tags added in v5.4.0 

func (o GroupOutput) Tags() pulumi.StringMapOutput

Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level

func (GroupOutput) TagsAll added in v5.4.0 

func (o GroupOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupState 

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
	// Configuration options for enabling insights.
	InsightsConfiguration GroupInsightsConfigurationPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapInput
}

func (GroupState) ElementType 

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. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// 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/v5/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v3/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 

func (*SamplingRule) ElementType() reflect.Type

func (*SamplingRule) ToSamplingRuleOutput 

func (i *SamplingRule) ToSamplingRuleOutput() SamplingRuleOutput

func (*SamplingRule) ToSamplingRuleOutputWithContext 

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. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	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 SamplingRuleArray 

type SamplingRuleArray []SamplingRuleInput

func (SamplingRuleArray) ElementType 

func (SamplingRuleArray) ElementType() reflect.Type

func (SamplingRuleArray) ToSamplingRuleArrayOutput 

func (i SamplingRuleArray) ToSamplingRuleArrayOutput() SamplingRuleArrayOutput

func (SamplingRuleArray) ToSamplingRuleArrayOutputWithContext 

func (i SamplingRuleArray) ToSamplingRuleArrayOutputWithContext(ctx context.Context) SamplingRuleArrayOutput

type SamplingRuleArrayInput 

type SamplingRuleArrayInput interface {
	pulumi.Input

	ToSamplingRuleArrayOutput() SamplingRuleArrayOutput
	ToSamplingRuleArrayOutputWithContext(context.Context) SamplingRuleArrayOutput
}

SamplingRuleArrayInput is an input type that accepts SamplingRuleArray and SamplingRuleArrayOutput values. You can construct a concrete instance of `SamplingRuleArrayInput` via: 

SamplingRuleArray{ SamplingRuleArgs{...} }

type SamplingRuleArrayOutput 

type SamplingRuleArrayOutput struct{ *pulumi.OutputState }

func (SamplingRuleArrayOutput) ElementType 

func (SamplingRuleArrayOutput) ElementType() reflect.Type

func (SamplingRuleArrayOutput) Index 

func (o SamplingRuleArrayOutput) Index(i pulumi.IntInput) SamplingRuleOutput

func (SamplingRuleArrayOutput) ToSamplingRuleArrayOutput 

func (o SamplingRuleArrayOutput) ToSamplingRuleArrayOutput() SamplingRuleArrayOutput

func (SamplingRuleArrayOutput) ToSamplingRuleArrayOutputWithContext 

func (o SamplingRuleArrayOutput) ToSamplingRuleArrayOutputWithContext(ctx context.Context) SamplingRuleArrayOutput

type SamplingRuleInput 

type SamplingRuleInput interface {
	pulumi.Input

	ToSamplingRuleOutput() SamplingRuleOutput
	ToSamplingRuleOutputWithContext(ctx context.Context) SamplingRuleOutput
}

type SamplingRuleMap 

type SamplingRuleMap map[string]SamplingRuleInput

func (SamplingRuleMap) ElementType 

func (SamplingRuleMap) ElementType() reflect.Type

func (SamplingRuleMap) ToSamplingRuleMapOutput 

func (i SamplingRuleMap) ToSamplingRuleMapOutput() SamplingRuleMapOutput

func (SamplingRuleMap) ToSamplingRuleMapOutputWithContext 

func (i SamplingRuleMap) ToSamplingRuleMapOutputWithContext(ctx context.Context) SamplingRuleMapOutput

type SamplingRuleMapInput 

type SamplingRuleMapInput interface {
	pulumi.Input

	ToSamplingRuleMapOutput() SamplingRuleMapOutput
	ToSamplingRuleMapOutputWithContext(context.Context) SamplingRuleMapOutput
}

SamplingRuleMapInput is an input type that accepts SamplingRuleMap and SamplingRuleMapOutput values. You can construct a concrete instance of `SamplingRuleMapInput` via: 

SamplingRuleMap{ "key": SamplingRuleArgs{...} }

type SamplingRuleMapOutput 

type SamplingRuleMapOutput struct{ *pulumi.OutputState }

func (SamplingRuleMapOutput) ElementType 

func (SamplingRuleMapOutput) ElementType() reflect.Type

func (SamplingRuleMapOutput) MapIndex 

func (o SamplingRuleMapOutput) MapIndex(k pulumi.StringInput) SamplingRuleOutput

func (SamplingRuleMapOutput) ToSamplingRuleMapOutput 

func (o SamplingRuleMapOutput) ToSamplingRuleMapOutput() SamplingRuleMapOutput

func (SamplingRuleMapOutput) ToSamplingRuleMapOutputWithContext 

func (o SamplingRuleMapOutput) ToSamplingRuleMapOutputWithContext(ctx context.Context) SamplingRuleMapOutput

type SamplingRuleOutput 

type SamplingRuleOutput struct{ *pulumi.OutputState }

func (SamplingRuleOutput) Arn added in v5.4.0 

func (o SamplingRuleOutput) Arn() pulumi.StringOutput

The ARN of the sampling rule.

func (SamplingRuleOutput) Attributes added in v5.4.0 

func (o SamplingRuleOutput) Attributes() pulumi.StringMapOutput

Matches attributes derived from the request.

func (SamplingRuleOutput) ElementType 

func (SamplingRuleOutput) ElementType() reflect.Type

func (SamplingRuleOutput) FixedRate added in v5.4.0 

func (o SamplingRuleOutput) FixedRate() pulumi.Float64Output

The percentage of matching requests to instrument, after the reservoir is exhausted.

func (SamplingRuleOutput) Host added in v5.4.0 

func (o SamplingRuleOutput) Host() pulumi.StringOutput

Matches the hostname from a request URL.

func (SamplingRuleOutput) HttpMethod added in v5.4.0 

func (o SamplingRuleOutput) HttpMethod() pulumi.StringOutput

Matches the HTTP method of a request.

func (SamplingRuleOutput) Priority added in v5.4.0 

func (o SamplingRuleOutput) Priority() pulumi.IntOutput

The priority of the sampling rule.

func (SamplingRuleOutput) ReservoirSize added in v5.4.0 

func (o SamplingRuleOutput) ReservoirSize() pulumi.IntOutput

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.

func (SamplingRuleOutput) ResourceArn added in v5.4.0 

func (o SamplingRuleOutput) ResourceArn() pulumi.StringOutput

Matches the ARN of the AWS resource on which the service runs.

func (SamplingRuleOutput) RuleName added in v5.4.0 

func (o SamplingRuleOutput) RuleName() pulumi.StringPtrOutput

The name of the sampling rule.

func (SamplingRuleOutput) ServiceName added in v5.4.0 

func (o SamplingRuleOutput) ServiceName() pulumi.StringOutput

Matches the `name` that the service uses to identify itself in segments.

func (SamplingRuleOutput) ServiceType added in v5.4.0 

func (o SamplingRuleOutput) ServiceType() pulumi.StringOutput

Matches the `origin` that the service uses to identify its type in segments.

func (SamplingRuleOutput) Tags added in v5.4.0 

func (o SamplingRuleOutput) Tags() pulumi.StringMapOutput

Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level

func (SamplingRuleOutput) TagsAll added in v5.4.0 

func (o SamplingRuleOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (SamplingRuleOutput) ToSamplingRuleOutput 

func (o SamplingRuleOutput) ToSamplingRuleOutput() SamplingRuleOutput

func (SamplingRuleOutput) ToSamplingRuleOutputWithContext 

func (o SamplingRuleOutput) ToSamplingRuleOutputWithContext(ctx context.Context) SamplingRuleOutput

func (SamplingRuleOutput) UrlPath added in v5.4.0 

func (o SamplingRuleOutput) UrlPath() pulumi.StringOutput

Matches the path from a request URL.

func (SamplingRuleOutput) Version added in v5.4.0 

func (o SamplingRuleOutput) Version() pulumi.IntOutput

The version of the sampling rule format (`1` )

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. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.