1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rbin
  5. getRule

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rbin.getRule

Get Started
aws-native logo

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Rbin::Rule

    Using getRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

    > Note: This function is named LookupRule in the Go SDK.

    public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:rbin:getRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Rule Arn is unique for each rule.
    Arn string
    Rule Arn is unique for each rule.
    arn String
    Rule Arn is unique for each rule.
    arn string
    Rule Arn is unique for each rule.
    arn str
    Rule Arn is unique for each rule.
    arn String
    Rule Arn is unique for each rule.

    getRule Result

    The following output properties are available:

    Arn string
    Rule Arn is unique for each rule.
    Description string
    The description of the retention rule.
    ExcludeResourceTags List<Pulumi.AwsNative.Rbin.Outputs.RuleResourceTag>
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    Identifier string
    The unique ID of the retention rule.
    LockState string
    The lock state for the retention rule.
    ResourceTags List<Pulumi.AwsNative.Rbin.Outputs.RuleResourceTag>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    RetentionPeriod Pulumi.AwsNative.Rbin.Outputs.RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    Status string
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Information about the tags assigned to the retention rule.
    Arn string
    Rule Arn is unique for each rule.
    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.
    Identifier string
    The unique ID of the retention rule.
    LockState string
    The lock state for the retention rule.
    ResourceTags []RuleResourceTag
    Information about the resource tags used to identify resources that are retained by the retention rule.
    RetentionPeriod RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    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.
    arn String
    Rule Arn is unique for each rule.
    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.
    identifier String
    The unique ID of the retention rule.
    lockState String
    The lock state for the retention rule.
    resourceTags List<RuleResourceTag>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    retentionPeriod RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    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.
    arn string
    Rule Arn is unique for each rule.
    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.
    identifier string
    The unique ID of the retention rule.
    lockState string
    The lock state for the retention rule.
    resourceTags RuleResourceTag[]
    Information about the resource tags used to identify resources that are retained by the retention rule.
    retentionPeriod RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    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.
    arn str
    Rule Arn is unique for each rule.
    description str
    The description of the retention rule.
    exclude_resource_tags Sequence[RuleResourceTag]
    Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
    identifier str
    The unique ID of the retention rule.
    lock_state str
    The lock state for the retention rule.
    resource_tags Sequence[RuleResourceTag]
    Information about the resource tags used to identify resources that are retained by the retention rule.
    retention_period RuleRetentionPeriod
    Information about the retention period for which the retention rule is to retain resources.
    status str
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    tags Sequence[root_Tag]
    Information about the tags assigned to the retention rule.
    arn String
    Rule Arn is unique for each rule.
    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.
    identifier String
    The unique ID of the retention rule.
    lockState String
    The lock state for the retention rule.
    resourceTags List<Property Map>
    Information about the resource tags used to identify resources that are retained by the retention rule.
    retentionPeriod Property Map
    Information about the retention period for which the retention rule is to retain resources.
    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.

    Supporting Types

    RuleResourceTag

    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

    RuleRetentionPeriod

    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

    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 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.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate