1. Packages
  2. AWS Native
  3. API Docs
  4. opsworkscm
  5. getServer

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.opsworkscm.getServer

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::OpsWorksCM::Server

    Using getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
    function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(server_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetServerResult
    def get_server_output(server_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
    func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
    {
        public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
        public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:opsworkscm:getServer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ServerName string
    The name of the server.
    ServerName string
    The name of the server.
    serverName String
    The name of the server.
    serverName string
    The name of the server.
    server_name str
    The name of the server.
    serverName String
    The name of the server.

    getServer Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    BackupRetentionCount int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    DisableAutomatedBackup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    Endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    PreferredBackupWindow string

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    PreferredMaintenanceWindow string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    Arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    BackupRetentionCount int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    DisableAutomatedBackup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    Endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    PreferredBackupWindow string

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    PreferredMaintenanceWindow string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    arn String
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    backupRetentionCount Integer
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    disableAutomatedBackup Boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    endpoint String
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    preferredBackupWindow String

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    preferredMaintenanceWindow String

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    backupRetentionCount number
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    disableAutomatedBackup boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    preferredBackupWindow string

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    preferredMaintenanceWindow string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    arn str
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    backup_retention_count int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    disable_automated_backup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    endpoint str
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    preferred_backup_window str

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    preferred_maintenance_window str

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    arn String
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    backupRetentionCount Number
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    disableAutomatedBackup Boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    endpoint String
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    preferredBackupWindow String

    The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

    Example: 08:00 , which represents a daily start time of 08:00 UTC.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    preferredMaintenanceWindow String

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

    Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi