We recommend new projects start with resources from the AWS provider.
aws-native.opsworkscm.getServer
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Server
Name string - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
- Server
Name string - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
- server
Name String - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
- server
Name string - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
- server_
name str - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
- server
Name String - The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
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
. - Backup
Retention intCount - 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 boolBackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - Endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - Preferred
Backup stringWindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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 stringWindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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
. - Backup
Retention intCount - 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 boolBackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - Endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - Preferred
Backup stringWindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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 stringWindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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
. - backup
Retention IntegerCount - 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 BooleanBackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - endpoint String
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - preferred
Backup StringWindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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 StringWindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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
. - backup
Retention numberCount - 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 booleanBackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - preferred
Backup stringWindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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 stringWindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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_ intcount - 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_ boolbackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - endpoint str
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - preferred_
backup_ strwindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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_ strwindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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
. - backup
Retention NumberCount - 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 BooleanBackup - Enable or disable scheduled backups. Valid values are
true
orfalse
. The default value istrue
. - endpoint String
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. - preferred
Backup StringWindow 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 backupsDDD:HH:MM
for weekly backups
MM
must be specified as00
. 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 StringWindow 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 as00
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
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
We recommend new projects start with resources from the AWS provider.