xray

package
v3.34.2 Latest Latest
Warning

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

 Go to latest Published: Mar 23, 2021 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 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"`
}

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/v3/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v2/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/v3/go/aws/kms"
"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 {
		exampleKey, err := kms.NewKey(ctx, "exampleKey", &kms.KeyArgs{
			Description:          pulumi.String("Some Key"),
			DeletionWindowInDays: pulumi.Int(7),
			Policy:               pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Id\": \"kms-tf-1\",\n", "  \"Statement\": [\n", "    {\n", "      \"Sid\": \"Enable IAM User Permissions\",\n", "      \"Effect\": \"Allow\",\n", "      \"Principal\": {\n", "        \"AWS\": \"*\"\n", "      },\n", "      \"Action\": \"kms:*\",\n", "      \"Resource\": \"*\"\n", "    }\n", "  ]\n", "}\n")),
		})
		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 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

func (*EncryptionConfig) ToEncryptionConfigPtrOutput added in v3.25.0 

func (i *EncryptionConfig) ToEncryptionConfigPtrOutput() EncryptionConfigPtrOutput

func (*EncryptionConfig) ToEncryptionConfigPtrOutputWithContext added in v3.25.0 

func (i *EncryptionConfig) ToEncryptionConfigPtrOutputWithContext(ctx context.Context) EncryptionConfigPtrOutput

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 EncryptionConfigArray added in v3.25.0 

type EncryptionConfigArray []EncryptionConfigInput

func (EncryptionConfigArray) ElementType added in v3.25.0 

func (EncryptionConfigArray) ElementType() reflect.Type

func (EncryptionConfigArray) ToEncryptionConfigArrayOutput added in v3.25.0 

func (i EncryptionConfigArray) ToEncryptionConfigArrayOutput() EncryptionConfigArrayOutput

func (EncryptionConfigArray) ToEncryptionConfigArrayOutputWithContext added in v3.25.0 

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

type EncryptionConfigArrayInput added in v3.25.0 

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 added in v3.25.0 

type EncryptionConfigArrayOutput struct{ *pulumi.OutputState }

func (EncryptionConfigArrayOutput) ElementType added in v3.25.0 

func (EncryptionConfigArrayOutput) ElementType() reflect.Type

func (EncryptionConfigArrayOutput) Index added in v3.25.0 

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

func (EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutput added in v3.25.0 

func (o EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutput() EncryptionConfigArrayOutput

func (EncryptionConfigArrayOutput) ToEncryptionConfigArrayOutputWithContext added in v3.25.0 

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

type EncryptionConfigInput added in v3.13.0 

type EncryptionConfigInput interface {
	pulumi.Input

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

type EncryptionConfigMap added in v3.25.0 

type EncryptionConfigMap map[string]EncryptionConfigInput

func (EncryptionConfigMap) ElementType added in v3.25.0 

func (EncryptionConfigMap) ElementType() reflect.Type

func (EncryptionConfigMap) ToEncryptionConfigMapOutput added in v3.25.0 

func (i EncryptionConfigMap) ToEncryptionConfigMapOutput() EncryptionConfigMapOutput

func (EncryptionConfigMap) ToEncryptionConfigMapOutputWithContext added in v3.25.0 

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

type EncryptionConfigMapInput added in v3.25.0 

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 added in v3.25.0 

type EncryptionConfigMapOutput struct{ *pulumi.OutputState }

func (EncryptionConfigMapOutput) ElementType added in v3.25.0 

func (EncryptionConfigMapOutput) ElementType() reflect.Type

func (EncryptionConfigMapOutput) MapIndex added in v3.25.0 

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

func (EncryptionConfigMapOutput) ToEncryptionConfigMapOutput added in v3.25.0 

func (o EncryptionConfigMapOutput) ToEncryptionConfigMapOutput() EncryptionConfigMapOutput

func (EncryptionConfigMapOutput) ToEncryptionConfigMapOutputWithContext added in v3.25.0 

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

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

func (EncryptionConfigOutput) ToEncryptionConfigPtrOutput added in v3.25.0 

func (o EncryptionConfigOutput) ToEncryptionConfigPtrOutput() EncryptionConfigPtrOutput

func (EncryptionConfigOutput) ToEncryptionConfigPtrOutputWithContext added in v3.25.0 

func (o EncryptionConfigOutput) ToEncryptionConfigPtrOutputWithContext(ctx context.Context) EncryptionConfigPtrOutput

type EncryptionConfigPtrInput added in v3.25.0 

type EncryptionConfigPtrInput interface {
	pulumi.Input

	ToEncryptionConfigPtrOutput() EncryptionConfigPtrOutput
	ToEncryptionConfigPtrOutputWithContext(ctx context.Context) EncryptionConfigPtrOutput
}

type EncryptionConfigPtrOutput added in v3.25.0 

type EncryptionConfigPtrOutput struct {
	*pulumi.OutputState
}

func (EncryptionConfigPtrOutput) ElementType added in v3.25.0 

func (EncryptionConfigPtrOutput) ElementType() reflect.Type

func (EncryptionConfigPtrOutput) ToEncryptionConfigPtrOutput added in v3.25.0 

func (o EncryptionConfigPtrOutput) ToEncryptionConfigPtrOutput() EncryptionConfigPtrOutput

func (EncryptionConfigPtrOutput) ToEncryptionConfigPtrOutputWithContext added in v3.25.0 

func (o EncryptionConfigPtrOutput) ToEncryptionConfigPtrOutputWithContext(ctx context.Context) EncryptionConfigPtrOutput

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) ElementType() reflect.Type

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

func (*Group) ToGroupPtrOutput added in v3.25.0 

func (i *Group) ToGroupPtrOutput() GroupPtrOutput

func (*Group) ToGroupPtrOutputWithContext added in v3.25.0 

func (i *Group) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

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 

func (GroupArgs) ElementType() reflect.Type

type GroupArray added in v3.25.0 

type GroupArray []GroupInput

func (GroupArray) ElementType added in v3.25.0 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput added in v3.25.0 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext added in v3.25.0 

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

type GroupArrayInput added in v3.25.0 

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 added in v3.25.0 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType added in v3.25.0 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index added in v3.25.0 

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

func (GroupArrayOutput) ToGroupArrayOutput added in v3.25.0 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext added in v3.25.0 

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

type GroupInput added in v3.13.0 

type GroupInput interface {
	pulumi.Input

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

type GroupMap added in v3.25.0 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType added in v3.25.0 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput added in v3.25.0 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext added in v3.25.0 

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

type GroupMapInput added in v3.25.0 

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 added in v3.25.0 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType added in v3.25.0 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex added in v3.25.0 

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

func (GroupMapOutput) ToGroupMapOutput added in v3.25.0 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext added in v3.25.0 

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

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

func (GroupOutput) ToGroupPtrOutput added in v3.25.0 

func (o GroupOutput) ToGroupPtrOutput() GroupPtrOutput

func (GroupOutput) ToGroupPtrOutputWithContext added in v3.25.0 

func (o GroupOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

type GroupPtrInput added in v3.25.0 

type GroupPtrInput interface {
	pulumi.Input

	ToGroupPtrOutput() GroupPtrOutput
	ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
}

type GroupPtrOutput added in v3.25.0 

type GroupPtrOutput struct {
	*pulumi.OutputState
}

func (GroupPtrOutput) ElementType added in v3.25.0 

func (GroupPtrOutput) ElementType() reflect.Type

func (GroupPtrOutput) ToGroupPtrOutput added in v3.25.0 

func (o GroupPtrOutput) ToGroupPtrOutput() GroupPtrOutput

func (GroupPtrOutput) ToGroupPtrOutputWithContext added in v3.25.0 

func (o GroupPtrOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput

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

func (*SamplingRule) ToSamplingRulePtrOutput added in v3.25.0 

func (i *SamplingRule) ToSamplingRulePtrOutput() SamplingRulePtrOutput

func (*SamplingRule) ToSamplingRulePtrOutputWithContext added in v3.25.0 

func (i *SamplingRule) ToSamplingRulePtrOutputWithContext(ctx context.Context) SamplingRulePtrOutput

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 SamplingRuleArray added in v3.25.0 

type SamplingRuleArray []SamplingRuleInput

func (SamplingRuleArray) ElementType added in v3.25.0 

func (SamplingRuleArray) ElementType() reflect.Type

func (SamplingRuleArray) ToSamplingRuleArrayOutput added in v3.25.0 

func (i SamplingRuleArray) ToSamplingRuleArrayOutput() SamplingRuleArrayOutput

func (SamplingRuleArray) ToSamplingRuleArrayOutputWithContext added in v3.25.0 

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

type SamplingRuleArrayInput added in v3.25.0 

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 added in v3.25.0 

type SamplingRuleArrayOutput struct{ *pulumi.OutputState }

func (SamplingRuleArrayOutput) ElementType added in v3.25.0 

func (SamplingRuleArrayOutput) ElementType() reflect.Type

func (SamplingRuleArrayOutput) Index added in v3.25.0 

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

func (SamplingRuleArrayOutput) ToSamplingRuleArrayOutput added in v3.25.0 

func (o SamplingRuleArrayOutput) ToSamplingRuleArrayOutput() SamplingRuleArrayOutput

func (SamplingRuleArrayOutput) ToSamplingRuleArrayOutputWithContext added in v3.25.0 

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

type SamplingRuleInput added in v3.13.0 

type SamplingRuleInput interface {
	pulumi.Input

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

type SamplingRuleMap added in v3.25.0 

type SamplingRuleMap map[string]SamplingRuleInput

func (SamplingRuleMap) ElementType added in v3.25.0 

func (SamplingRuleMap) ElementType() reflect.Type

func (SamplingRuleMap) ToSamplingRuleMapOutput added in v3.25.0 

func (i SamplingRuleMap) ToSamplingRuleMapOutput() SamplingRuleMapOutput

func (SamplingRuleMap) ToSamplingRuleMapOutputWithContext added in v3.25.0 

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

type SamplingRuleMapInput added in v3.25.0 

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 added in v3.25.0 

type SamplingRuleMapOutput struct{ *pulumi.OutputState }

func (SamplingRuleMapOutput) ElementType added in v3.25.0 

func (SamplingRuleMapOutput) ElementType() reflect.Type

func (SamplingRuleMapOutput) MapIndex added in v3.25.0 

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

func (SamplingRuleMapOutput) ToSamplingRuleMapOutput added in v3.25.0 

func (o SamplingRuleMapOutput) ToSamplingRuleMapOutput() SamplingRuleMapOutput

func (SamplingRuleMapOutput) ToSamplingRuleMapOutputWithContext added in v3.25.0 

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

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

func (SamplingRuleOutput) ToSamplingRulePtrOutput added in v3.25.0 

func (o SamplingRuleOutput) ToSamplingRulePtrOutput() SamplingRulePtrOutput

func (SamplingRuleOutput) ToSamplingRulePtrOutputWithContext added in v3.25.0 

func (o SamplingRuleOutput) ToSamplingRulePtrOutputWithContext(ctx context.Context) SamplingRulePtrOutput

type SamplingRulePtrInput added in v3.25.0 

type SamplingRulePtrInput interface {
	pulumi.Input

	ToSamplingRulePtrOutput() SamplingRulePtrOutput
	ToSamplingRulePtrOutputWithContext(ctx context.Context) SamplingRulePtrOutput
}

type SamplingRulePtrOutput added in v3.25.0 

type SamplingRulePtrOutput struct {
	*pulumi.OutputState
}

func (SamplingRulePtrOutput) ElementType added in v3.25.0 

func (SamplingRulePtrOutput) ElementType() reflect.Type

func (SamplingRulePtrOutput) ToSamplingRulePtrOutput added in v3.25.0 

func (o SamplingRulePtrOutput) ToSamplingRulePtrOutput() SamplingRulePtrOutput

func (SamplingRulePtrOutput) ToSamplingRulePtrOutputWithContext added in v3.25.0 

func (o SamplingRulePtrOutput) ToSamplingRulePtrOutputWithContext(ctx context.Context) SamplingRulePtrOutput

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

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.