rbin

package
v6.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 13, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Rule 

type Rule struct {
	pulumi.CustomResourceState

	Arn pulumi.StringOutput `pulumi:"arn"`
	// The retention rule description.
	Description pulumi.StringOutput `pulumi:"description"`
	// Information about the retention rule lock configuration. See `lockConfiguration` below.
	LockConfiguration RuleLockConfigurationPtrOutput `pulumi:"lockConfiguration"`
	// (Timestamp) The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.
	LockEndTime pulumi.StringOutput `pulumi:"lockEndTime"`
	// (Optional) The lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pendingUnlock`, `unlocked`.
	LockState pulumi.StringOutput `pulumi:"lockState"`
	// Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See `resourceTags` below.
	ResourceTags RuleResourceTagArrayOutput `pulumi:"resourceTags"`
	// The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`.
	ResourceType pulumi.StringOutput `pulumi:"resourceType"`
	// Information about the retention period for which the retention rule is to retain resources. See `retentionPeriod` below.
	//
	// The following arguments are optional:
	RetentionPeriod RuleRetentionPeriodOutput `pulumi:"retentionPeriod"`
	// (String) The state of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`.
	Status  pulumi.StringOutput    `pulumi:"status"`
	Tags    pulumi.StringMapOutput `pulumi:"tags"`
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Resource for managing an AWS RBin Rule.

## Example Usage ### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rbin"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rbin.NewRule(ctx, "example", &rbin.RuleArgs{
			Description: pulumi.String("example_rule"),
			ResourceTags: rbin.RuleResourceTagArray{
				&rbin.RuleResourceTagArgs{
					ResourceTagKey:   pulumi.String("tag_key"),
					ResourceTagValue: pulumi.String("tag_value"),
				},
			},
			ResourceType: pulumi.String("EBS_SNAPSHOT"),
			RetentionPeriod: &rbin.RuleRetentionPeriodArgs{
				RetentionPeriodUnit:  pulumi.String("DAYS"),
				RetentionPeriodValue: pulumi.Int(10),
			},
			Tags: pulumi.StringMap{
				"test_tag_key": pulumi.String("test_tag_value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import RBin Rule using the `id`. For example:

```sh 

$ pulumi import aws:rbin/rule:Rule example examplerule

```

func GetRule 

func GetRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RuleState, opts ...pulumi.ResourceOption) (*Rule, error)

GetRule gets an existing Rule 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 NewRule 

func NewRule(ctx *pulumi.Context,
	name string, args *RuleArgs, opts ...pulumi.ResourceOption) (*Rule, error)

NewRule registers a new resource with the given unique name, arguments, and options.

func (*Rule) ElementType 

func (*Rule) ElementType() reflect.Type

func (*Rule) ToOutput added in v6.1.0 

func (i *Rule) ToOutput(ctx context.Context) pulumix.Output[*Rule]

func (*Rule) ToRuleOutput 

func (i *Rule) ToRuleOutput() RuleOutput

func (*Rule) ToRuleOutputWithContext 

func (i *Rule) ToRuleOutputWithContext(ctx context.Context) RuleOutput

type RuleArgs 

type RuleArgs struct {
	// The retention rule description.
	Description pulumi.StringPtrInput
	// Information about the retention rule lock configuration. See `lockConfiguration` below.
	LockConfiguration RuleLockConfigurationPtrInput
	// Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See `resourceTags` below.
	ResourceTags RuleResourceTagArrayInput
	// The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`.
	ResourceType pulumi.StringInput
	// Information about the retention period for which the retention rule is to retain resources. See `retentionPeriod` below.
	//
	// The following arguments are optional:
	RetentionPeriod RuleRetentionPeriodInput
	Tags            pulumi.StringMapInput
}

The set of arguments for constructing a Rule resource.

func (RuleArgs) ElementType 

func (RuleArgs) ElementType() reflect.Type

type RuleArray 

type RuleArray []RuleInput

func (RuleArray) ElementType 

func (RuleArray) ElementType() reflect.Type

func (RuleArray) ToOutput added in v6.1.0 

func (i RuleArray) ToOutput(ctx context.Context) pulumix.Output[[]*Rule]

func (RuleArray) ToRuleArrayOutput 

func (i RuleArray) ToRuleArrayOutput() RuleArrayOutput

func (RuleArray) ToRuleArrayOutputWithContext 

func (i RuleArray) ToRuleArrayOutputWithContext(ctx context.Context) RuleArrayOutput

type RuleArrayInput 

type RuleArrayInput interface {
	pulumi.Input

	ToRuleArrayOutput() RuleArrayOutput
	ToRuleArrayOutputWithContext(context.Context) RuleArrayOutput
}

RuleArrayInput is an input type that accepts RuleArray and RuleArrayOutput values. You can construct a concrete instance of `RuleArrayInput` via: 

RuleArray{ RuleArgs{...} }

type RuleArrayOutput 

type RuleArrayOutput struct{ *pulumi.OutputState }

func (RuleArrayOutput) ElementType 

func (RuleArrayOutput) ElementType() reflect.Type

func (RuleArrayOutput) Index 

func (o RuleArrayOutput) Index(i pulumi.IntInput) RuleOutput

func (RuleArrayOutput) ToOutput added in v6.1.0 

func (o RuleArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*Rule]

func (RuleArrayOutput) ToRuleArrayOutput 

func (o RuleArrayOutput) ToRuleArrayOutput() RuleArrayOutput

func (RuleArrayOutput) ToRuleArrayOutputWithContext 

func (o RuleArrayOutput) ToRuleArrayOutputWithContext(ctx context.Context) RuleArrayOutput

type RuleInput 

type RuleInput interface {
	pulumi.Input

	ToRuleOutput() RuleOutput
	ToRuleOutputWithContext(ctx context.Context) RuleOutput
}

type RuleLockConfiguration 

type RuleLockConfiguration struct {
	// Information about the retention rule unlock delay. See `unlockDelay` below.
	UnlockDelay RuleLockConfigurationUnlockDelay `pulumi:"unlockDelay"`
}

type RuleLockConfigurationArgs 

type RuleLockConfigurationArgs struct {
	// Information about the retention rule unlock delay. See `unlockDelay` below.
	UnlockDelay RuleLockConfigurationUnlockDelayInput `pulumi:"unlockDelay"`
}

func (RuleLockConfigurationArgs) ElementType 

func (RuleLockConfigurationArgs) ElementType() reflect.Type

func (RuleLockConfigurationArgs) ToOutput added in v6.1.0 

func (i RuleLockConfigurationArgs) ToOutput(ctx context.Context) pulumix.Output[RuleLockConfiguration]

func (RuleLockConfigurationArgs) ToRuleLockConfigurationOutput 

func (i RuleLockConfigurationArgs) ToRuleLockConfigurationOutput() RuleLockConfigurationOutput

func (RuleLockConfigurationArgs) ToRuleLockConfigurationOutputWithContext 

func (i RuleLockConfigurationArgs) ToRuleLockConfigurationOutputWithContext(ctx context.Context) RuleLockConfigurationOutput

func (RuleLockConfigurationArgs) ToRuleLockConfigurationPtrOutput 

func (i RuleLockConfigurationArgs) ToRuleLockConfigurationPtrOutput() RuleLockConfigurationPtrOutput

func (RuleLockConfigurationArgs) ToRuleLockConfigurationPtrOutputWithContext 

func (i RuleLockConfigurationArgs) ToRuleLockConfigurationPtrOutputWithContext(ctx context.Context) RuleLockConfigurationPtrOutput

type RuleLockConfigurationInput 

type RuleLockConfigurationInput interface {
	pulumi.Input

	ToRuleLockConfigurationOutput() RuleLockConfigurationOutput
	ToRuleLockConfigurationOutputWithContext(context.Context) RuleLockConfigurationOutput
}

RuleLockConfigurationInput is an input type that accepts RuleLockConfigurationArgs and RuleLockConfigurationOutput values. You can construct a concrete instance of `RuleLockConfigurationInput` via: 

RuleLockConfigurationArgs{...}

type RuleLockConfigurationOutput 

type RuleLockConfigurationOutput struct{ *pulumi.OutputState }

func (RuleLockConfigurationOutput) ElementType 

func (RuleLockConfigurationOutput) ElementType() reflect.Type

func (RuleLockConfigurationOutput) ToOutput added in v6.1.0 

func (o RuleLockConfigurationOutput) ToOutput(ctx context.Context) pulumix.Output[RuleLockConfiguration]

func (RuleLockConfigurationOutput) ToRuleLockConfigurationOutput 

func (o RuleLockConfigurationOutput) ToRuleLockConfigurationOutput() RuleLockConfigurationOutput

func (RuleLockConfigurationOutput) ToRuleLockConfigurationOutputWithContext 

func (o RuleLockConfigurationOutput) ToRuleLockConfigurationOutputWithContext(ctx context.Context) RuleLockConfigurationOutput

func (RuleLockConfigurationOutput) ToRuleLockConfigurationPtrOutput 

func (o RuleLockConfigurationOutput) ToRuleLockConfigurationPtrOutput() RuleLockConfigurationPtrOutput

func (RuleLockConfigurationOutput) ToRuleLockConfigurationPtrOutputWithContext 

func (o RuleLockConfigurationOutput) ToRuleLockConfigurationPtrOutputWithContext(ctx context.Context) RuleLockConfigurationPtrOutput

func (RuleLockConfigurationOutput) UnlockDelay 

func (o RuleLockConfigurationOutput) UnlockDelay() RuleLockConfigurationUnlockDelayOutput

Information about the retention rule unlock delay. See `unlockDelay` below.

type RuleLockConfigurationPtrInput 

type RuleLockConfigurationPtrInput interface {
	pulumi.Input

	ToRuleLockConfigurationPtrOutput() RuleLockConfigurationPtrOutput
	ToRuleLockConfigurationPtrOutputWithContext(context.Context) RuleLockConfigurationPtrOutput
}

RuleLockConfigurationPtrInput is an input type that accepts RuleLockConfigurationArgs, RuleLockConfigurationPtr and RuleLockConfigurationPtrOutput values. You can construct a concrete instance of `RuleLockConfigurationPtrInput` via: 

        RuleLockConfigurationArgs{...}

or:

        nil

func RuleLockConfigurationPtr 

func RuleLockConfigurationPtr(v *RuleLockConfigurationArgs) RuleLockConfigurationPtrInput

type RuleLockConfigurationPtrOutput 

type RuleLockConfigurationPtrOutput struct{ *pulumi.OutputState }

func (RuleLockConfigurationPtrOutput) Elem 

func (o RuleLockConfigurationPtrOutput) Elem() RuleLockConfigurationOutput

func (RuleLockConfigurationPtrOutput) ElementType 

func (RuleLockConfigurationPtrOutput) ElementType() reflect.Type

func (RuleLockConfigurationPtrOutput) ToOutput added in v6.1.0 

func (o RuleLockConfigurationPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*RuleLockConfiguration]

func (RuleLockConfigurationPtrOutput) ToRuleLockConfigurationPtrOutput 

func (o RuleLockConfigurationPtrOutput) ToRuleLockConfigurationPtrOutput() RuleLockConfigurationPtrOutput

func (RuleLockConfigurationPtrOutput) ToRuleLockConfigurationPtrOutputWithContext 

func (o RuleLockConfigurationPtrOutput) ToRuleLockConfigurationPtrOutputWithContext(ctx context.Context) RuleLockConfigurationPtrOutput

func (RuleLockConfigurationPtrOutput) UnlockDelay 

func (o RuleLockConfigurationPtrOutput) UnlockDelay() RuleLockConfigurationUnlockDelayPtrOutput

Information about the retention rule unlock delay. See `unlockDelay` below.

type RuleLockConfigurationUnlockDelay 

type RuleLockConfigurationUnlockDelay struct {
	// The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
	UnlockDelayUnit string `pulumi:"unlockDelayUnit"`
	// The unlock delay period, measured in the unit specified for UnlockDelayUnit.
	UnlockDelayValue int `pulumi:"unlockDelayValue"`
}

type RuleLockConfigurationUnlockDelayArgs 

type RuleLockConfigurationUnlockDelayArgs struct {
	// The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
	UnlockDelayUnit pulumi.StringInput `pulumi:"unlockDelayUnit"`
	// The unlock delay period, measured in the unit specified for UnlockDelayUnit.
	UnlockDelayValue pulumi.IntInput `pulumi:"unlockDelayValue"`
}

func (RuleLockConfigurationUnlockDelayArgs) ElementType 

func (RuleLockConfigurationUnlockDelayArgs) ElementType() reflect.Type

func (RuleLockConfigurationUnlockDelayArgs) ToOutput added in v6.1.0 

func (i RuleLockConfigurationUnlockDelayArgs) ToOutput(ctx context.Context) pulumix.Output[RuleLockConfigurationUnlockDelay]

func (RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayOutput 

func (i RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayOutput() RuleLockConfigurationUnlockDelayOutput

func (RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayOutputWithContext 

func (i RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayOutputWithContext(ctx context.Context) RuleLockConfigurationUnlockDelayOutput

func (RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayPtrOutput 

func (i RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayPtrOutput() RuleLockConfigurationUnlockDelayPtrOutput

func (RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext 

func (i RuleLockConfigurationUnlockDelayArgs) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext(ctx context.Context) RuleLockConfigurationUnlockDelayPtrOutput

type RuleLockConfigurationUnlockDelayInput 

type RuleLockConfigurationUnlockDelayInput interface {
	pulumi.Input

	ToRuleLockConfigurationUnlockDelayOutput() RuleLockConfigurationUnlockDelayOutput
	ToRuleLockConfigurationUnlockDelayOutputWithContext(context.Context) RuleLockConfigurationUnlockDelayOutput
}

RuleLockConfigurationUnlockDelayInput is an input type that accepts RuleLockConfigurationUnlockDelayArgs and RuleLockConfigurationUnlockDelayOutput values. You can construct a concrete instance of `RuleLockConfigurationUnlockDelayInput` via: 

RuleLockConfigurationUnlockDelayArgs{...}

type RuleLockConfigurationUnlockDelayOutput 

type RuleLockConfigurationUnlockDelayOutput struct{ *pulumi.OutputState }

func (RuleLockConfigurationUnlockDelayOutput) ElementType 

func (RuleLockConfigurationUnlockDelayOutput) ElementType() reflect.Type

func (RuleLockConfigurationUnlockDelayOutput) ToOutput added in v6.1.0 

func (o RuleLockConfigurationUnlockDelayOutput) ToOutput(ctx context.Context) pulumix.Output[RuleLockConfigurationUnlockDelay]

func (RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayOutput 

func (o RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayOutput() RuleLockConfigurationUnlockDelayOutput

func (RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayOutputWithContext 

func (o RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayOutputWithContext(ctx context.Context) RuleLockConfigurationUnlockDelayOutput

func (RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayPtrOutput 

func (o RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayPtrOutput() RuleLockConfigurationUnlockDelayPtrOutput

func (RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext 

func (o RuleLockConfigurationUnlockDelayOutput) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext(ctx context.Context) RuleLockConfigurationUnlockDelayPtrOutput

func (RuleLockConfigurationUnlockDelayOutput) UnlockDelayUnit 

func (o RuleLockConfigurationUnlockDelayOutput) UnlockDelayUnit() pulumi.StringOutput

The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

func (RuleLockConfigurationUnlockDelayOutput) UnlockDelayValue 

func (o RuleLockConfigurationUnlockDelayOutput) UnlockDelayValue() pulumi.IntOutput

The unlock delay period, measured in the unit specified for UnlockDelayUnit.

type RuleLockConfigurationUnlockDelayPtrInput 

type RuleLockConfigurationUnlockDelayPtrInput interface {
	pulumi.Input

	ToRuleLockConfigurationUnlockDelayPtrOutput() RuleLockConfigurationUnlockDelayPtrOutput
	ToRuleLockConfigurationUnlockDelayPtrOutputWithContext(context.Context) RuleLockConfigurationUnlockDelayPtrOutput
}

RuleLockConfigurationUnlockDelayPtrInput is an input type that accepts RuleLockConfigurationUnlockDelayArgs, RuleLockConfigurationUnlockDelayPtr and RuleLockConfigurationUnlockDelayPtrOutput values. You can construct a concrete instance of `RuleLockConfigurationUnlockDelayPtrInput` via: 

        RuleLockConfigurationUnlockDelayArgs{...}

or:

        nil

func RuleLockConfigurationUnlockDelayPtr 

func RuleLockConfigurationUnlockDelayPtr(v *RuleLockConfigurationUnlockDelayArgs) RuleLockConfigurationUnlockDelayPtrInput

type RuleLockConfigurationUnlockDelayPtrOutput 

type RuleLockConfigurationUnlockDelayPtrOutput struct{ *pulumi.OutputState }

func (RuleLockConfigurationUnlockDelayPtrOutput) Elem 

func (o RuleLockConfigurationUnlockDelayPtrOutput) Elem() RuleLockConfigurationUnlockDelayOutput

func (RuleLockConfigurationUnlockDelayPtrOutput) ElementType 

func (RuleLockConfigurationUnlockDelayPtrOutput) ElementType() reflect.Type

func (RuleLockConfigurationUnlockDelayPtrOutput) ToOutput added in v6.1.0 

func (o RuleLockConfigurationUnlockDelayPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*RuleLockConfigurationUnlockDelay]

func (RuleLockConfigurationUnlockDelayPtrOutput) ToRuleLockConfigurationUnlockDelayPtrOutput 

func (o RuleLockConfigurationUnlockDelayPtrOutput) ToRuleLockConfigurationUnlockDelayPtrOutput() RuleLockConfigurationUnlockDelayPtrOutput

func (RuleLockConfigurationUnlockDelayPtrOutput) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext 

func (o RuleLockConfigurationUnlockDelayPtrOutput) ToRuleLockConfigurationUnlockDelayPtrOutputWithContext(ctx context.Context) RuleLockConfigurationUnlockDelayPtrOutput

func (RuleLockConfigurationUnlockDelayPtrOutput) UnlockDelayUnit 

func (o RuleLockConfigurationUnlockDelayPtrOutput) UnlockDelayUnit() pulumi.StringPtrOutput

The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

func (RuleLockConfigurationUnlockDelayPtrOutput) UnlockDelayValue 

func (o RuleLockConfigurationUnlockDelayPtrOutput) UnlockDelayValue() pulumi.IntPtrOutput

The unlock delay period, measured in the unit specified for UnlockDelayUnit.

type RuleMap 

type RuleMap map[string]RuleInput

func (RuleMap) ElementType 

func (RuleMap) ElementType() reflect.Type

func (RuleMap) ToOutput added in v6.1.0 

func (i RuleMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Rule]

func (RuleMap) ToRuleMapOutput 

func (i RuleMap) ToRuleMapOutput() RuleMapOutput

func (RuleMap) ToRuleMapOutputWithContext 

func (i RuleMap) ToRuleMapOutputWithContext(ctx context.Context) RuleMapOutput

type RuleMapInput 

type RuleMapInput interface {
	pulumi.Input

	ToRuleMapOutput() RuleMapOutput
	ToRuleMapOutputWithContext(context.Context) RuleMapOutput
}

RuleMapInput is an input type that accepts RuleMap and RuleMapOutput values. You can construct a concrete instance of `RuleMapInput` via: 

RuleMap{ "key": RuleArgs{...} }

type RuleMapOutput 

type RuleMapOutput struct{ *pulumi.OutputState }

func (RuleMapOutput) ElementType 

func (RuleMapOutput) ElementType() reflect.Type

func (RuleMapOutput) MapIndex 

func (o RuleMapOutput) MapIndex(k pulumi.StringInput) RuleOutput

func (RuleMapOutput) ToOutput added in v6.1.0 

func (o RuleMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*Rule]

func (RuleMapOutput) ToRuleMapOutput 

func (o RuleMapOutput) ToRuleMapOutput() RuleMapOutput

func (RuleMapOutput) ToRuleMapOutputWithContext 

func (o RuleMapOutput) ToRuleMapOutputWithContext(ctx context.Context) RuleMapOutput

type RuleOutput 

type RuleOutput struct{ *pulumi.OutputState }

func (RuleOutput) Arn 

func (o RuleOutput) Arn() pulumi.StringOutput

func (RuleOutput) Description 

func (o RuleOutput) Description() pulumi.StringOutput

The retention rule description.

func (RuleOutput) ElementType 

func (RuleOutput) ElementType() reflect.Type

func (RuleOutput) LockConfiguration 

func (o RuleOutput) LockConfiguration() RuleLockConfigurationPtrOutput

Information about the retention rule lock configuration. See `lockConfiguration` below.

func (RuleOutput) LockEndTime 

func (o RuleOutput) LockEndTime() pulumi.StringOutput

(Timestamp) The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

func (RuleOutput) LockState 

func (o RuleOutput) LockState() pulumi.StringOutput

(Optional) The lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pendingUnlock`, `unlocked`.

func (RuleOutput) ResourceTags 

func (o RuleOutput) ResourceTags() RuleResourceTagArrayOutput

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See `resourceTags` below.

func (RuleOutput) ResourceType 

func (o RuleOutput) ResourceType() pulumi.StringOutput

The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`.

func (RuleOutput) RetentionPeriod 

func (o RuleOutput) RetentionPeriod() RuleRetentionPeriodOutput

Information about the retention period for which the retention rule is to retain resources. See `retentionPeriod` below.

The following arguments are optional:

func (RuleOutput) Status 

func (o RuleOutput) Status() pulumi.StringOutput

(String) The state of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`.

func (RuleOutput) Tags 

func (o RuleOutput) Tags() pulumi.StringMapOutput

func (RuleOutput) TagsAll 

func (o RuleOutput) TagsAll() pulumi.StringMapOutput

func (RuleOutput) ToOutput added in v6.1.0 

func (o RuleOutput) ToOutput(ctx context.Context) pulumix.Output[*Rule]

func (RuleOutput) ToRuleOutput 

func (o RuleOutput) ToRuleOutput() RuleOutput

func (RuleOutput) ToRuleOutputWithContext 

func (o RuleOutput) ToRuleOutputWithContext(ctx context.Context) RuleOutput

type RuleResourceTag 

type RuleResourceTag struct {
	// The tag key.
	//
	// The following argument is optional:
	ResourceTagKey string `pulumi:"resourceTagKey"`
	// The tag value.
	ResourceTagValue *string `pulumi:"resourceTagValue"`
}

type RuleResourceTagArgs 

type RuleResourceTagArgs struct {
	// The tag key.
	//
	// The following argument is optional:
	ResourceTagKey pulumi.StringInput `pulumi:"resourceTagKey"`
	// The tag value.
	ResourceTagValue pulumi.StringPtrInput `pulumi:"resourceTagValue"`
}

func (RuleResourceTagArgs) ElementType 

func (RuleResourceTagArgs) ElementType() reflect.Type

func (RuleResourceTagArgs) ToOutput added in v6.1.0 

func (i RuleResourceTagArgs) ToOutput(ctx context.Context) pulumix.Output[RuleResourceTag]

func (RuleResourceTagArgs) ToRuleResourceTagOutput 

func (i RuleResourceTagArgs) ToRuleResourceTagOutput() RuleResourceTagOutput

func (RuleResourceTagArgs) ToRuleResourceTagOutputWithContext 

func (i RuleResourceTagArgs) ToRuleResourceTagOutputWithContext(ctx context.Context) RuleResourceTagOutput

type RuleResourceTagArray 

type RuleResourceTagArray []RuleResourceTagInput

func (RuleResourceTagArray) ElementType 

func (RuleResourceTagArray) ElementType() reflect.Type

func (RuleResourceTagArray) ToOutput added in v6.1.0 

func (i RuleResourceTagArray) ToOutput(ctx context.Context) pulumix.Output[[]RuleResourceTag]

func (RuleResourceTagArray) ToRuleResourceTagArrayOutput 

func (i RuleResourceTagArray) ToRuleResourceTagArrayOutput() RuleResourceTagArrayOutput

func (RuleResourceTagArray) ToRuleResourceTagArrayOutputWithContext 

func (i RuleResourceTagArray) ToRuleResourceTagArrayOutputWithContext(ctx context.Context) RuleResourceTagArrayOutput

type RuleResourceTagArrayInput 

type RuleResourceTagArrayInput interface {
	pulumi.Input

	ToRuleResourceTagArrayOutput() RuleResourceTagArrayOutput
	ToRuleResourceTagArrayOutputWithContext(context.Context) RuleResourceTagArrayOutput
}

RuleResourceTagArrayInput is an input type that accepts RuleResourceTagArray and RuleResourceTagArrayOutput values. You can construct a concrete instance of `RuleResourceTagArrayInput` via: 

RuleResourceTagArray{ RuleResourceTagArgs{...} }

type RuleResourceTagArrayOutput 

type RuleResourceTagArrayOutput struct{ *pulumi.OutputState }

func (RuleResourceTagArrayOutput) ElementType 

func (RuleResourceTagArrayOutput) ElementType() reflect.Type

func (RuleResourceTagArrayOutput) Index 

func (o RuleResourceTagArrayOutput) Index(i pulumi.IntInput) RuleResourceTagOutput

func (RuleResourceTagArrayOutput) ToOutput added in v6.1.0 

func (o RuleResourceTagArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]RuleResourceTag]

func (RuleResourceTagArrayOutput) ToRuleResourceTagArrayOutput 

func (o RuleResourceTagArrayOutput) ToRuleResourceTagArrayOutput() RuleResourceTagArrayOutput

func (RuleResourceTagArrayOutput) ToRuleResourceTagArrayOutputWithContext 

func (o RuleResourceTagArrayOutput) ToRuleResourceTagArrayOutputWithContext(ctx context.Context) RuleResourceTagArrayOutput

type RuleResourceTagInput 

type RuleResourceTagInput interface {
	pulumi.Input

	ToRuleResourceTagOutput() RuleResourceTagOutput
	ToRuleResourceTagOutputWithContext(context.Context) RuleResourceTagOutput
}

RuleResourceTagInput is an input type that accepts RuleResourceTagArgs and RuleResourceTagOutput values. You can construct a concrete instance of `RuleResourceTagInput` via: 

RuleResourceTagArgs{...}

type RuleResourceTagOutput 

type RuleResourceTagOutput struct{ *pulumi.OutputState }

func (RuleResourceTagOutput) ElementType 

func (RuleResourceTagOutput) ElementType() reflect.Type

func (RuleResourceTagOutput) ResourceTagKey 

func (o RuleResourceTagOutput) ResourceTagKey() pulumi.StringOutput

The tag key.

The following argument is optional:

func (RuleResourceTagOutput) ResourceTagValue 

func (o RuleResourceTagOutput) ResourceTagValue() pulumi.StringPtrOutput

The tag value.

func (RuleResourceTagOutput) ToOutput added in v6.1.0 

func (o RuleResourceTagOutput) ToOutput(ctx context.Context) pulumix.Output[RuleResourceTag]

func (RuleResourceTagOutput) ToRuleResourceTagOutput 

func (o RuleResourceTagOutput) ToRuleResourceTagOutput() RuleResourceTagOutput

func (RuleResourceTagOutput) ToRuleResourceTagOutputWithContext 

func (o RuleResourceTagOutput) ToRuleResourceTagOutputWithContext(ctx context.Context) RuleResourceTagOutput

type RuleRetentionPeriod 

type RuleRetentionPeriod struct {
	// The unit of time in which the retention period is measured. Currently, only DAYS is supported.
	RetentionPeriodUnit string `pulumi:"retentionPeriodUnit"`
	// The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.
	RetentionPeriodValue int `pulumi:"retentionPeriodValue"`
}

type RuleRetentionPeriodArgs 

type RuleRetentionPeriodArgs struct {
	// The unit of time in which the retention period is measured. Currently, only DAYS is supported.
	RetentionPeriodUnit pulumi.StringInput `pulumi:"retentionPeriodUnit"`
	// The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.
	RetentionPeriodValue pulumi.IntInput `pulumi:"retentionPeriodValue"`
}

func (RuleRetentionPeriodArgs) ElementType 

func (RuleRetentionPeriodArgs) ElementType() reflect.Type

func (RuleRetentionPeriodArgs) ToOutput added in v6.1.0 

func (i RuleRetentionPeriodArgs) ToOutput(ctx context.Context) pulumix.Output[RuleRetentionPeriod]

func (RuleRetentionPeriodArgs) ToRuleRetentionPeriodOutput 

func (i RuleRetentionPeriodArgs) ToRuleRetentionPeriodOutput() RuleRetentionPeriodOutput

func (RuleRetentionPeriodArgs) ToRuleRetentionPeriodOutputWithContext 

func (i RuleRetentionPeriodArgs) ToRuleRetentionPeriodOutputWithContext(ctx context.Context) RuleRetentionPeriodOutput

func (RuleRetentionPeriodArgs) ToRuleRetentionPeriodPtrOutput 

func (i RuleRetentionPeriodArgs) ToRuleRetentionPeriodPtrOutput() RuleRetentionPeriodPtrOutput

func (RuleRetentionPeriodArgs) ToRuleRetentionPeriodPtrOutputWithContext 

func (i RuleRetentionPeriodArgs) ToRuleRetentionPeriodPtrOutputWithContext(ctx context.Context) RuleRetentionPeriodPtrOutput

type RuleRetentionPeriodInput 

type RuleRetentionPeriodInput interface {
	pulumi.Input

	ToRuleRetentionPeriodOutput() RuleRetentionPeriodOutput
	ToRuleRetentionPeriodOutputWithContext(context.Context) RuleRetentionPeriodOutput
}

RuleRetentionPeriodInput is an input type that accepts RuleRetentionPeriodArgs and RuleRetentionPeriodOutput values. You can construct a concrete instance of `RuleRetentionPeriodInput` via: 

RuleRetentionPeriodArgs{...}

type RuleRetentionPeriodOutput 

type RuleRetentionPeriodOutput struct{ *pulumi.OutputState }

func (RuleRetentionPeriodOutput) ElementType 

func (RuleRetentionPeriodOutput) ElementType() reflect.Type

func (RuleRetentionPeriodOutput) RetentionPeriodUnit 

func (o RuleRetentionPeriodOutput) RetentionPeriodUnit() pulumi.StringOutput

The unit of time in which the retention period is measured. Currently, only DAYS is supported.

func (RuleRetentionPeriodOutput) RetentionPeriodValue 

func (o RuleRetentionPeriodOutput) RetentionPeriodValue() pulumi.IntOutput

The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

func (RuleRetentionPeriodOutput) ToOutput added in v6.1.0 

func (o RuleRetentionPeriodOutput) ToOutput(ctx context.Context) pulumix.Output[RuleRetentionPeriod]

func (RuleRetentionPeriodOutput) ToRuleRetentionPeriodOutput 

func (o RuleRetentionPeriodOutput) ToRuleRetentionPeriodOutput() RuleRetentionPeriodOutput

func (RuleRetentionPeriodOutput) ToRuleRetentionPeriodOutputWithContext 

func (o RuleRetentionPeriodOutput) ToRuleRetentionPeriodOutputWithContext(ctx context.Context) RuleRetentionPeriodOutput

func (RuleRetentionPeriodOutput) ToRuleRetentionPeriodPtrOutput 

func (o RuleRetentionPeriodOutput) ToRuleRetentionPeriodPtrOutput() RuleRetentionPeriodPtrOutput

func (RuleRetentionPeriodOutput) ToRuleRetentionPeriodPtrOutputWithContext 

func (o RuleRetentionPeriodOutput) ToRuleRetentionPeriodPtrOutputWithContext(ctx context.Context) RuleRetentionPeriodPtrOutput

type RuleRetentionPeriodPtrInput 

type RuleRetentionPeriodPtrInput interface {
	pulumi.Input

	ToRuleRetentionPeriodPtrOutput() RuleRetentionPeriodPtrOutput
	ToRuleRetentionPeriodPtrOutputWithContext(context.Context) RuleRetentionPeriodPtrOutput
}

RuleRetentionPeriodPtrInput is an input type that accepts RuleRetentionPeriodArgs, RuleRetentionPeriodPtr and RuleRetentionPeriodPtrOutput values. You can construct a concrete instance of `RuleRetentionPeriodPtrInput` via: 

        RuleRetentionPeriodArgs{...}

or:

        nil

func RuleRetentionPeriodPtr 

func RuleRetentionPeriodPtr(v *RuleRetentionPeriodArgs) RuleRetentionPeriodPtrInput

type RuleRetentionPeriodPtrOutput 

type RuleRetentionPeriodPtrOutput struct{ *pulumi.OutputState }

func (RuleRetentionPeriodPtrOutput) Elem 

func (o RuleRetentionPeriodPtrOutput) Elem() RuleRetentionPeriodOutput

func (RuleRetentionPeriodPtrOutput) ElementType 

func (RuleRetentionPeriodPtrOutput) ElementType() reflect.Type

func (RuleRetentionPeriodPtrOutput) RetentionPeriodUnit 

func (o RuleRetentionPeriodPtrOutput) RetentionPeriodUnit() pulumi.StringPtrOutput

The unit of time in which the retention period is measured. Currently, only DAYS is supported.

func (RuleRetentionPeriodPtrOutput) RetentionPeriodValue 

func (o RuleRetentionPeriodPtrOutput) RetentionPeriodValue() pulumi.IntPtrOutput

The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

func (RuleRetentionPeriodPtrOutput) ToOutput added in v6.1.0 

func (o RuleRetentionPeriodPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*RuleRetentionPeriod]

func (RuleRetentionPeriodPtrOutput) ToRuleRetentionPeriodPtrOutput 

func (o RuleRetentionPeriodPtrOutput) ToRuleRetentionPeriodPtrOutput() RuleRetentionPeriodPtrOutput

func (RuleRetentionPeriodPtrOutput) ToRuleRetentionPeriodPtrOutputWithContext 

func (o RuleRetentionPeriodPtrOutput) ToRuleRetentionPeriodPtrOutputWithContext(ctx context.Context) RuleRetentionPeriodPtrOutput

type RuleState 

type RuleState struct {
	Arn pulumi.StringPtrInput
	// The retention rule description.
	Description pulumi.StringPtrInput
	// Information about the retention rule lock configuration. See `lockConfiguration` below.
	LockConfiguration RuleLockConfigurationPtrInput
	// (Timestamp) The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.
	LockEndTime pulumi.StringPtrInput
	// (Optional) The lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pendingUnlock`, `unlocked`.
	LockState pulumi.StringPtrInput
	// Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See `resourceTags` below.
	ResourceTags RuleResourceTagArrayInput
	// The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`.
	ResourceType pulumi.StringPtrInput
	// Information about the retention period for which the retention rule is to retain resources. See `retentionPeriod` below.
	//
	// The following arguments are optional:
	RetentionPeriod RuleRetentionPeriodPtrInput
	// (String) The state of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`.
	Status  pulumi.StringPtrInput
	Tags    pulumi.StringMapInput
	TagsAll pulumi.StringMapInput
}

func (RuleState) ElementType 

func (RuleState) 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.