Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rbin
  5. Rule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rbin.Rule

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Rbin::Rule

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         resource_type: Optional[RuleResourceType] = None,
         retention_period: Optional[RuleRetentionPeriodArgs] = None,
         description: Optional[str] = None,
         exclude_resource_tags: Optional[Sequence[RuleResourceTagArgs]] = None,
         lock_configuration: Optional[RuleUnlockDelayArgs] = None,
         resource_tags: Optional[Sequence[RuleResourceTagArgs]] = None,
         status: Optional[str] = None,
         tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

    type: aws-native:rbin:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Rule resource accepts the following input properties:

    ResourceType Pulumi.AwsNative.Rbin.RuleResourceType
    The resource type retained by the retention rule.
    RetentionPeriod Pulumi.AwsNative.Rbin.Inputs.RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    Description string
    The description of the retention rule.
    ExcludeResourceTags List<Pulumi.AwsNative.Rbin.Inputs.RuleResourceTag>
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    LockConfiguration Pulumi.AwsNative.Rbin.Inputs.RuleUnlockDelay
    Information about the retention rule lock configuration.
    ResourceTags List<Pulumi.AwsNative.Rbin.Inputs.RuleResourceTag>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    Status string
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Information about the tags assigned to the retention rule.
    ResourceType RuleResourceType
    The resource type retained by the retention rule.
    RetentionPeriod RuleRetentionPeriodArgs
    Information about the retention period for which the retention rule is to retain resources.
    Description string
    The description of the retention rule.
    ExcludeResourceTags []RuleResourceTagArgs
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    LockConfiguration RuleUnlockDelayArgs
    Information about the retention rule lock configuration.
    ResourceTags []RuleResourceTagArgs
    Information about the resource tags used to identify resources that are retained by the retention rule.
    Status string
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    Tags TagArgs
    Information about the tags assigned to the retention rule.
    resourceType RuleResourceType
    The resource type retained by the retention rule.
    retentionPeriod RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    description String
    The description of the retention rule.
    excludeResourceTags List<RuleResourceTag>
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    lockConfiguration RuleUnlockDelay
    Information about the retention rule lock configuration.
    resourceTags List<RuleResourceTag>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    status String
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    tags List<Tag>
    Information about the tags assigned to the retention rule.
    resourceType RuleResourceType
    The resource type retained by the retention rule.
    retentionPeriod RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    description string
    The description of the retention rule.
    excludeResourceTags RuleResourceTag[]
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    lockConfiguration RuleUnlockDelay
    Information about the retention rule lock configuration.
    resourceTags RuleResourceTag[]
    Information about the resource tags used to identify resources that are retained by the retention rule.
    status string
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    tags Tag[]
    Information about the tags assigned to the retention rule.
    resource_type RuleResourceType
    The resource type retained by the retention rule.
    retention_period RuleRetentionPeriodArgs
    Information about the retention period for which the retention rule is to retain resources.
    description str
    The description of the retention rule.
    exclude_resource_tags Sequence[RuleResourceTagArgs]
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    lock_configuration RuleUnlockDelayArgs
    Information about the retention rule lock configuration.
    resource_tags Sequence[RuleResourceTagArgs]
    Information about the resource tags used to identify resources that are retained by the retention rule.
    status str
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    tags Sequence[TagArgs]
    Information about the tags assigned to the retention rule.
    resourceType "EBS_SNAPSHOT" | "EC2_IMAGE"
    The resource type retained by the retention rule.
    retentionPeriod Property Map
    Information about the retention period for which the retention rule is to retain resources.
    description String
    The description of the retention rule.
    excludeResourceTags List<Property Map>
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    lockConfiguration Property Map
    Information about the retention rule lock configuration.
    resourceTags List<Property Map>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    status String
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    tags List<Property Map>
    Information about the tags assigned to the retention rule.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

    Arn string
    Rule Arn is unique for each rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    The unique ID of the retention rule.
    LockState string
    The lock state for the retention rule.
    Arn string
    Rule Arn is unique for each rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    The unique ID of the retention rule.
    LockState string
    The lock state for the retention rule.
    arn String
    Rule Arn is unique for each rule.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    The unique ID of the retention rule.
    lockState String
    The lock state for the retention rule.
    arn string
    Rule Arn is unique for each rule.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    The unique ID of the retention rule.
    lockState string
    The lock state for the retention rule.
    arn str
    Rule Arn is unique for each rule.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    The unique ID of the retention rule.
    lock_state str
    The lock state for the retention rule.
    arn String
    Rule Arn is unique for each rule.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    The unique ID of the retention rule.
    lockState String
    The lock state for the retention rule.

    Supporting Types

    RuleResourceTag, RuleResourceTagArgs

    ResourceTagKey string
    The tag key of the resource.
    ResourceTagValue string
    The tag value of the resource
    ResourceTagKey string
    The tag key of the resource.
    ResourceTagValue string
    The tag value of the resource
    resourceTagKey String
    The tag key of the resource.
    resourceTagValue String
    The tag value of the resource
    resourceTagKey string
    The tag key of the resource.
    resourceTagValue string
    The tag value of the resource
    resource_tag_key str
    The tag key of the resource.
    resource_tag_value str
    The tag value of the resource
    resourceTagKey String
    The tag key of the resource.
    resourceTagValue String
    The tag value of the resource

    RuleResourceType, RuleResourceTypeArgs

    EbsSnapshot
    EBS_SNAPSHOT
    Ec2Image
    EC2_IMAGE
    RuleResourceTypeEbsSnapshot
    EBS_SNAPSHOT
    RuleResourceTypeEc2Image
    EC2_IMAGE
    EbsSnapshot
    EBS_SNAPSHOT
    Ec2Image
    EC2_IMAGE
    EbsSnapshot
    EBS_SNAPSHOT
    Ec2Image
    EC2_IMAGE
    EBS_SNAPSHOT
    EBS_SNAPSHOT
    EC2_IMAGE
    EC2_IMAGE
    "EBS_SNAPSHOT"
    EBS_SNAPSHOT
    "EC2_IMAGE"
    EC2_IMAGE

    RuleRetentionPeriod, RuleRetentionPeriodArgs

    RetentionPeriodUnit Pulumi.AwsNative.Rbin.RuleRetentionPeriodRetentionPeriodUnit
    The retention period unit of the rule
    RetentionPeriodValue int
    The retention period value of the rule.
    RetentionPeriodUnit RuleRetentionPeriodRetentionPeriodUnit
    The retention period unit of the rule
    RetentionPeriodValue int
    The retention period value of the rule.
    retentionPeriodUnit RuleRetentionPeriodRetentionPeriodUnit
    The retention period unit of the rule
    retentionPeriodValue Integer
    The retention period value of the rule.
    retentionPeriodUnit RuleRetentionPeriodRetentionPeriodUnit
    The retention period unit of the rule
    retentionPeriodValue number
    The retention period value of the rule.
    retention_period_unit RuleRetentionPeriodRetentionPeriodUnit
    The retention period unit of the rule
    retention_period_value int
    The retention period value of the rule.
    retentionPeriodUnit "DAYS"
    The retention period unit of the rule
    retentionPeriodValue Number
    The retention period value of the rule.

    RuleRetentionPeriodRetentionPeriodUnit, RuleRetentionPeriodRetentionPeriodUnitArgs

    Days
    DAYS
    RuleRetentionPeriodRetentionPeriodUnitDays
    DAYS
    Days
    DAYS
    Days
    DAYS
    DAYS
    DAYS
    "DAYS"
    DAYS

    RuleUnlockDelay, RuleUnlockDelayArgs

    UnlockDelayUnit Pulumi.AwsNative.Rbin.RuleUnlockDelayUnlockDelayUnit
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    UnlockDelayValue int
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.
    UnlockDelayUnit RuleUnlockDelayUnlockDelayUnit
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    UnlockDelayValue int
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.
    unlockDelayUnit RuleUnlockDelayUnlockDelayUnit
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    unlockDelayValue Integer
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.
    unlockDelayUnit RuleUnlockDelayUnlockDelayUnit
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    unlockDelayValue number
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.
    unlock_delay_unit RuleUnlockDelayUnlockDelayUnit
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    unlock_delay_value int
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.
    unlockDelayUnit "DAYS"
    The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
    unlockDelayValue Number
    The unlock delay period, measured in the unit specified for UnlockDelayUnit.

    RuleUnlockDelayUnlockDelayUnit, RuleUnlockDelayUnlockDelayUnitArgs

    Days
    DAYS
    RuleUnlockDelayUnlockDelayUnitDays
    DAYS
    Days
    DAYS
    Days
    DAYS
    DAYS
    DAYS
    "DAYS"
    DAYS

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native