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

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.opsworkscm.Server

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Resource Type definition for AWS::OpsWorksCM::Server

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var pivotalKey = config.Require("pivotalKey");
        var password = config.Require("password");
        var myChefServer = new AwsNative.OpsWorksCm.Server("myChefServer", new()
        {
            BackupRetentionCount = 12,
            CustomCertificate = "-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
            CustomDomain = "https://aws.my-company.com",
            CustomPrivateKey = "-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
            DisableAutomatedBackup = false,
            Engine = "ChefAutomate",
            EngineVersion = "2",
            EngineAttributes = new[]
            {
                new AwsNative.OpsWorksCm.Inputs.ServerEngineAttributeArgs
                {
                    Name = "CHEF_AUTOMATE_PIVOTAL_KEY",
                    Value = pivotalKey,
                },
                new AwsNative.OpsWorksCm.Inputs.ServerEngineAttributeArgs
                {
                    Name = "CHEF_AUTOMATE_ADMIN_PASSWORD",
                    Value = password,
                },
            },
            EngineModel = "Single",
            InstanceProfileArn = "INSTANCE-PROFILE-ARN",
            InstanceType = "r5.xlarge",
            PreferredBackupWindow = "08:00",
            PreferredMaintenanceWindow = "Fri:08:00",
            ServiceRoleArn = "SERVICE-ROLE-ARN",
            Tags = new[]
            {
                new AwsNative.Inputs.TagArgs
                {
                    Key = "Stage",
                    Value = "Production",
                },
                new AwsNative.Inputs.TagArgs
                {
                    Key = "Name",
                    Value = "test-owcm-server",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["endpoint"] = myChefServer.Endpoint,
        };
    });
    
    package main
    
    import (
    	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/opsworkscm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		pivotalKey := cfg.Require("pivotalKey")
    		password := cfg.Require("password")
    		myChefServer, err := opsworkscm.NewServer(ctx, "myChefServer", &opsworkscm.ServerArgs{
    			BackupRetentionCount:   pulumi.Int(12),
    			CustomCertificate:      pulumi.String("-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----"),
    			CustomDomain:           pulumi.String("https://aws.my-company.com"),
    			CustomPrivateKey:       pulumi.String("-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----"),
    			DisableAutomatedBackup: pulumi.Bool(false),
    			Engine:                 pulumi.String("ChefAutomate"),
    			EngineVersion:          pulumi.String("2"),
    			EngineAttributes: opsworkscm.ServerEngineAttributeArray{
    				&opsworkscm.ServerEngineAttributeArgs{
    					Name:  pulumi.String("CHEF_AUTOMATE_PIVOTAL_KEY"),
    					Value: pulumi.String(pivotalKey),
    				},
    				&opsworkscm.ServerEngineAttributeArgs{
    					Name:  pulumi.String("CHEF_AUTOMATE_ADMIN_PASSWORD"),
    					Value: pulumi.String(password),
    				},
    			},
    			EngineModel:                pulumi.String("Single"),
    			InstanceProfileArn:         pulumi.String("INSTANCE-PROFILE-ARN"),
    			InstanceType:               pulumi.String("r5.xlarge"),
    			PreferredBackupWindow:      pulumi.String("08:00"),
    			PreferredMaintenanceWindow: pulumi.String("Fri:08:00"),
    			ServiceRoleArn:             pulumi.String("SERVICE-ROLE-ARN"),
    			Tags: aws.TagArray{
    				&aws.TagArgs{
    					Key:   pulumi.String("Stage"),
    					Value: pulumi.String("Production"),
    				},
    				&aws.TagArgs{
    					Key:   pulumi.String("Name"),
    					Value: pulumi.String("test-owcm-server"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("endpoint", myChefServer.Endpoint)
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    config = pulumi.Config()
    pivotal_key = config.require("pivotalKey")
    password = config.require("password")
    my_chef_server = aws_native.opsworkscm.Server("myChefServer",
        backup_retention_count=12,
        custom_certificate="-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
        custom_domain="https://aws.my-company.com",
        custom_private_key="-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
        disable_automated_backup=False,
        engine="ChefAutomate",
        engine_version="2",
        engine_attributes=[
            aws_native.opsworkscm.ServerEngineAttributeArgs(
                name="CHEF_AUTOMATE_PIVOTAL_KEY",
                value=pivotal_key,
            ),
            aws_native.opsworkscm.ServerEngineAttributeArgs(
                name="CHEF_AUTOMATE_ADMIN_PASSWORD",
                value=password,
            ),
        ],
        engine_model="Single",
        instance_profile_arn="INSTANCE-PROFILE-ARN",
        instance_type="r5.xlarge",
        preferred_backup_window="08:00",
        preferred_maintenance_window="Fri:08:00",
        service_role_arn="SERVICE-ROLE-ARN",
        tags=[
            aws_native.TagArgs(
                key="Stage",
                value="Production",
            ),
            aws_native.TagArgs(
                key="Name",
                value="test-owcm-server",
            ),
        ])
    pulumi.export("endpoint", my_chef_server.endpoint)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const config = new pulumi.Config();
    const pivotalKey = config.require("pivotalKey");
    const password = config.require("password");
    const myChefServer = new aws_native.opsworkscm.Server("myChefServer", {
        backupRetentionCount: 12,
        customCertificate: "-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
        customDomain: "https://aws.my-company.com",
        customPrivateKey: "-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
        disableAutomatedBackup: false,
        engine: "ChefAutomate",
        engineVersion: "2",
        engineAttributes: [
            {
                name: "CHEF_AUTOMATE_PIVOTAL_KEY",
                value: pivotalKey,
            },
            {
                name: "CHEF_AUTOMATE_ADMIN_PASSWORD",
                value: password,
            },
        ],
        engineModel: "Single",
        instanceProfileArn: "INSTANCE-PROFILE-ARN",
        instanceType: "r5.xlarge",
        preferredBackupWindow: "08:00",
        preferredMaintenanceWindow: "Fri:08:00",
        serviceRoleArn: "SERVICE-ROLE-ARN",
        tags: [
            {
                key: "Stage",
                value: "Production",
            },
            {
                key: "Name",
                value: "test-owcm-server",
            },
        ],
    });
    export const endpoint = myChefServer.endpoint;
    

    Coming soon!

    Create Server Resource

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

    Constructor syntax

    new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);
    @overload
    def Server(resource_name: str,
               args: ServerArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Server(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               instance_profile_arn: Optional[str] = None,
               service_role_arn: Optional[str] = None,
               instance_type: Optional[str] = None,
               engine_version: Optional[str] = None,
               backup_retention_count: Optional[int] = None,
               custom_private_key: Optional[str] = None,
               disable_automated_backup: Optional[bool] = None,
               engine: Optional[str] = None,
               engine_attributes: Optional[Sequence[ServerEngineAttributeArgs]] = None,
               engine_model: Optional[str] = None,
               associate_public_ip_address: Optional[bool] = None,
               custom_certificate: Optional[str] = None,
               custom_domain: Optional[str] = None,
               key_pair: Optional[str] = None,
               preferred_backup_window: Optional[str] = None,
               preferred_maintenance_window: Optional[str] = None,
               security_group_ids: Optional[Sequence[str]] = None,
               server_name: Optional[str] = None,
               backup_id: Optional[str] = None,
               subnet_ids: Optional[Sequence[str]] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)
    public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
    public Server(String name, ServerArgs args)
    public Server(String name, ServerArgs args, CustomResourceOptions options)
    
    type: aws-native:opsworkscm:Server
    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 ServerArgs
    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 ServerArgs
    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 ServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const serverResource = new aws_native.opsworkscm.Server("serverResource", {
        instanceProfileArn: "string",
        serviceRoleArn: "string",
        instanceType: "string",
        engineVersion: "string",
        backupRetentionCount: 0,
        customPrivateKey: "string",
        disableAutomatedBackup: false,
        engine: "string",
        engineAttributes: [{
            name: "string",
            value: "string",
        }],
        engineModel: "string",
        associatePublicIpAddress: false,
        customCertificate: "string",
        customDomain: "string",
        keyPair: "string",
        preferredBackupWindow: "string",
        preferredMaintenanceWindow: "string",
        securityGroupIds: ["string"],
        serverName: "string",
        backupId: "string",
        subnetIds: ["string"],
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Server Resource Properties

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

    Inputs

    The Server resource accepts the following input properties:

    Outputs

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

    Arn string
    Endpoint string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Endpoint string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    endpoint String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    endpoint string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    endpoint str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    endpoint String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ServerEngineAttribute, ServerEngineAttributeArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    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

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

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi