1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. secretsmanager
  5. getRotationSchedule

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.secretsmanager.getRotationSchedule

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Resource Type definition for AWS::SecretsManager::RotationSchedule

    Using getRotationSchedule

    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 getRotationSchedule(args: GetRotationScheduleArgs, opts?: InvokeOptions): Promise<GetRotationScheduleResult>
    function getRotationScheduleOutput(args: GetRotationScheduleOutputArgs, opts?: InvokeOptions): Output<GetRotationScheduleResult>
    def get_rotation_schedule(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRotationScheduleResult
    def get_rotation_schedule_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetRotationScheduleResult]
    func LookupRotationSchedule(ctx *Context, args *LookupRotationScheduleArgs, opts ...InvokeOption) (*LookupRotationScheduleResult, error)
    func LookupRotationScheduleOutput(ctx *Context, args *LookupRotationScheduleOutputArgs, opts ...InvokeOption) LookupRotationScheduleResultOutput

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

    public static class GetRotationSchedule 
    {
        public static Task<GetRotationScheduleResult> InvokeAsync(GetRotationScheduleArgs args, InvokeOptions? opts = null)
        public static Output<GetRotationScheduleResult> Invoke(GetRotationScheduleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRotationScheduleResult> getRotationSchedule(GetRotationScheduleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:secretsmanager:getRotationSchedule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ARN of the secret.
    Id string
    The ARN of the secret.
    id String
    The ARN of the secret.
    id string
    The ARN of the secret.
    id str
    The ARN of the secret.
    id String
    The ARN of the secret.

    getRotationSchedule Result

    The following output properties are available:

    Id string
    The ARN of the secret.
    RotationLambdaArn string
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    RotationRules Pulumi.AwsNative.SecretsManager.Outputs.RotationScheduleRotationRules
    A structure that defines the rotation configuration for this secret.
    Id string
    The ARN of the secret.
    RotationLambdaArn string
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    RotationRules RotationScheduleRotationRules
    A structure that defines the rotation configuration for this secret.
    id String
    The ARN of the secret.
    rotationLambdaArn String
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    rotationRules RotationScheduleRotationRules
    A structure that defines the rotation configuration for this secret.
    id string
    The ARN of the secret.
    rotationLambdaArn string
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    rotationRules RotationScheduleRotationRules
    A structure that defines the rotation configuration for this secret.
    id str
    The ARN of the secret.
    rotation_lambda_arn str
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    rotation_rules RotationScheduleRotationRules
    A structure that defines the rotation configuration for this secret.
    id String
    The ARN of the secret.
    rotationLambdaArn String
    The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
    rotationRules Property Map
    A structure that defines the rotation configuration for this secret.

    Supporting Types

    RotationScheduleRotationRules

    AutomaticallyAfterDays int
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    Duration string
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    ScheduleExpression string
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
    AutomaticallyAfterDays int
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    Duration string
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    ScheduleExpression string
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
    automaticallyAfterDays Integer
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    duration String
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    scheduleExpression String
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
    automaticallyAfterDays number
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    duration string
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    scheduleExpression string
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
    automatically_after_days int
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    duration str
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    schedule_expression str
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.
    automaticallyAfterDays Number
    The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
    duration String
    The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day.
    scheduleExpression String
    A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.

    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.9.0 published on Monday, Nov 18, 2024 by Pulumi