Class: Aws::OpsWorks::Resource

Inherits:

Object

Object
Aws::OpsWorks::Resource

show all

Defined in:: lib/aws-sdk-opsworks/resource.rb

Overview

This class provides a resource oriented interface for OpsWorks. To create a resource object:

resource = Aws::OpsWorks::Resource.new(region: 'us-west-2')

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass ‘:client`, a default client will be constructed.

client = Aws::OpsWorks::Client.new(region: 'us-west-2')
resource = Aws::OpsWorks::Resource.new(client: client)

Actions collapse

#create_stack(options = {}) ⇒ Stack

Associations collapse

#layer(id) ⇒ Layer
#stack(id) ⇒ Stack
#stacks(options = {}) ⇒ Stack::Collection

Instance Method Summary collapse

#client ⇒ Client
#initialize(options = {}) ⇒ Resource constructor

A new instance of Resource.

Constructor Details

#initialize(options = {}) ⇒ `Resource`

Returns a new instance of Resource.

Parameters:

options ({}) (defaults to: {})

Options Hash (options):

:client (Client)



27
28
29

# File 'lib/aws-sdk-opsworks/resource.rb', line 27

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#client ⇒ `Client`

Returns:

(Client)



32
33
34

# File 'lib/aws-sdk-opsworks/resource.rb', line 32

def client
  @client
end

#create_stack(options = {}) ⇒ `Stack`

Examples:

Request syntax with placeholder values


stack = ops_works.create_stack({
  name: "String", # required
  region: "String", # required
  vpc_id: "String",
  attributes: {
    "Color" => "String",
  },
  service_role_arn: "String", # required
  default_instance_profile_arn: "String", # required
  default_os: "String",
  hostname_theme: "String",
  default_availability_zone: "String",
  default_subnet_id: "String",
  custom_json: "String",
  configuration_manager: {
    name: "String",
    version: "String",
  },
  chef_configuration: {
    manage_berkshelf: false,
    berkshelf_version: "String",
  },
  use_custom_cookbooks: false,
  use_opsworks_security_groups: false,
  custom_cookbooks_source: {
    type: "git", # accepts git, svn, archive, s3
    url: "String",
    username: "String",
    password: "String",
    ssh_key: "String",
    revision: "String",
  },
  default_ssh_key_name: "String",
  default_root_device_type: "ebs", # accepts ebs, instance-store
  agent_version: "String",
})

Parameters:

options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:name (required, String) —

The stack name. Stack names can be a maximum of 64 characters.
:region (required, String) —
The stack’s Amazon Web Services Region, such as ‘ap-south-1`. For more information about Amazon Web Services Regions, see [Regions and Endpoints].

<note markdown=“1”> In the CLI, this API maps to the ‘–stack-region` parameter. If the `–stack-region` parameter and the CLI common parameter `–region` are set to the same value, the stack uses a regional endpoint. If the `–stack-region` parameter is not set, but the CLI `–region` parameter is, this also results in a stack with a regional endpoint. However, if the `–region` parameter is set to `us-east-1`, and the `–stack-region` parameter is set to one of the following, then the stack uses a legacy or classic region: `us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2`. In this case, the actual API endpoint of the stack is in `us-east-1`. Only the preceding regions are supported as classic regions in the `us-east-1` API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend that you use regional endpoints for new stacks. The CLI common `–region` parameter always specifies a regional API endpoint; it cannot be used to specify a classic OpsWorks Stacks region.
```
</note>
```
[1]: docs.aws.amazon.com/general/latest/gr/rande.html
:vpc_id (String) —
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack’s region. All instances are launched into this VPC. You cannot change the ID later.
- If your account supports EC2-Classic, the default value is ‘no VPC`.
- If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the ‘DefaultAvailabilityZone` or the `DefaultSubnetId` parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:
- It must belong to a VPC in your account that is in the specified region.
- You must specify a value for ‘DefaultSubnetId`.
For more information about how to use OpsWorks Stacks with a VPC, see [Running a Stack in a VPC]. For more information about default VPC and EC2-Classic, see [Supported Platforms].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
:attributes (Hash<String,String>) —

One or more user-defined key-value pairs to be added to the stack attributes.
:service_role_arn (required, String) —

The stack’s IAM role, which allows OpsWorks Stacks to work with Amazon Web Services resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see [Using Identifiers].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
:default_instance_profile_arn (required, String) —

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack’s EC2 instances. For more information about IAM ARNs, see [Using Identifiers].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
:default_os (String) —
The stack’s default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as ‘Amazon Linux 2`, `Amazon Linux 2018.03`, `Amazon Linux 2017.09`, `Amazon Linux 2017.03`, `Amazon Linux 2016.09`, `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux 2015.03`.
- A supported Ubuntu operating system, such as ‘Ubuntu 18.04 LTS`, `Ubuntu 16.04 LTS`, `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
- ‘CentOS Linux 7`
- ‘Red Hat Enterprise Linux 7`
- A supported Windows operating system, such as ‘Microsoft Windows Server 2012 R2 Base`, `Microsoft Windows Server 2012 R2 with SQL Server Express`, `Microsoft Windows Server 2012 R2 with SQL Server Standard`, or `Microsoft Windows Server 2012 R2 with SQL Server Web`.
- A custom AMI: ‘Custom`. You specify the custom AMI you want to use when you create instances. For more information, see [ Using Custom AMIs].
The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see [OpsWorks Stacks Operating Systems].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html
:hostname_theme (String) —
The stack’s host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack’s instances. By default, ‘HostnameTheme` is set to `Layer_Dependent`, which creates host names by appending integers to the layer’s short name. The other themes are:
- ‘Baked_Goods`
- ‘Clouds`
- ‘Europe_Cities`
- ‘Fruits`
- ‘Greek_Deities_and_Titans`
- ‘Legendary_creatures_from_Japan`
- ‘Planets_and_Moons`
- ‘Roman_Deities`
- ‘Scottish_Islands`
- ‘US_Cities`
- ‘Wild_Cats`
To obtain a generated host name, call ‘GetHostNameSuggestion`, which returns a host name based on the current theme.
:default_availability_zone (String) —

The stack’s default Availability Zone, which must be in the specified region. For more information, see [Regions and Endpoints]. If you also specify a value for ‘DefaultSubnetId`, the subnet must be in the same zone. For more information, see the `VpcId` parameter description.

[1]: docs.aws.amazon.com/general/latest/gr/rande.html
:default_subnet_id (String) —

The stack’s default VPC subnet ID. This parameter is required if you specify a value for the ‘VpcId` parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for `DefaultAvailabilityZone`, the subnet must be in that zone. For information on default values and when this parameter is required, see the `VpcId` parameter description.
:custom_json (String) —

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

‘“”value1“, ”key2“: ”value2“,…”`

For more information about custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html
:configuration_manager (Types::StackConfigurationManager) —

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
:chef_configuration (Types::ChefConfiguration) —

A ‘ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html
:use_custom_cookbooks (Boolean) —

Whether the stack uses custom cookbooks.
:use_opsworks_security_groups (Boolean) —
Whether to associate the OpsWorks Stacks built-in security groups with the stack’s layers.

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With ‘UseOpsworksSecurityGroups` you can instead provide your own custom security groups. `UseOpsworksSecurityGroups` has the following settings:
- True - OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
- False - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see [Create a New Stack].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html
:custom_cookbooks_source (Types::Source) —

Contains the information required to retrieve an app or cookbook from a repository. For more information, see [Adding Apps] or [Cookbooks and Recipes].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html
:default_ssh_key_name (String) —

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see [ Using SSH to Communicate with an Instance] and [ Managing SSH Access]. You can override this setting by specifying a different key pair, or no key pair, when you [ create an instance].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html [3]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html
:default_root_device_type (String) —

The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is ‘instance-store`. For more information, see [Storage for the Root Device].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device
:agent_version (String) —
The default OpsWorks Stacks agent version. You have the following options:
- Auto-update - Set this parameter to ‘LATEST`. OpsWorks Stacks automatically installs new agent versions on the stack’s instances as soon as they are available.
- Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. OpsWorks Stacks installs that version on the stack’s instances.
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

<note markdown=“1”> You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.
```
</note>
```

Returns:

(Stack)

# File 'lib/aws-sdk-opsworks/resource.rb', line 357

def create_stack(options = {})
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_stack(options)
  end
  Stack.new(
    id: resp.data.stack_id,
    client: @client
  )
end

#layer(id) ⇒ `Layer`

Parameters:

id (String)

Returns:

(Layer)

# File 'lib/aws-sdk-opsworks/resource.rb', line 371

def layer(id)
  Layer.new(
    id: id,
    client: @client
  )
end

#stack(id) ⇒ `Stack`

Parameters:

id (String)

Returns:

(Stack)

# File 'lib/aws-sdk-opsworks/resource.rb', line 380

def stack(id)
  Stack.new(
    id: id,
    client: @client
  )
end

#stacks(options = {}) ⇒ `Stack::Collection`

Examples:

Request syntax with placeholder values


stacks = ops_works.stacks({
  stack_ids: ["String"],
})

Parameters:

options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:stack_ids (Array<String>) —

An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks, ‘DescribeStacks` returns a description of every stack. If the IAM policy that is attached to an IAM user limits the `DescribeStacks` action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise, `DescribeStacks` returns an `AccessDenied` error.

Returns:

(Stack::Collection)

# File 'lib/aws-sdk-opsworks/resource.rb', line 402

def stacks(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_stacks(options)
    end
    resp.data.stacks.each do |s|
      batch << Stack.new(
        id: s.stack_id,
        data: s,
        client: @client
      )
    end
    y.yield(batch)
  end
  Stack::Collection.new(batches)
end

Class: Aws::OpsWorks::Resource

Overview

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Instance Method Details

#client ⇒ Client

#create_stack(options = {}) ⇒ Stack

#layer(id) ⇒ Layer

#stack(id) ⇒ Stack

#stacks(options = {}) ⇒ Stack::Collection

#initialize(options = {}) ⇒ `Resource`

#client ⇒ `Client`

#create_stack(options = {}) ⇒ `Stack`

#layer(id) ⇒ `Layer`

#stack(id) ⇒ `Stack`

#stacks(options = {}) ⇒ `Stack::Collection`