Skip to content

OpsWorksServiceResource#

Index > OpsWorks > OpsWorksServiceResource

Auto-generated documentation for OpsWorks type annotations stubs module mypy-boto3-opsworks.

OpsWorksServiceResource#

Type annotations and code completion for boto3.resource("opsworks"), included resources and collections. boto3 documentation

# OpsWorksServiceResource usage example

from mypy_boto3_opsworks.service_resource import OpsWorksServiceResource

def get_opsworks_resource() -> OpsWorksServiceResource:
    return boto3.resource("opsworks")

Attributes#

Collections#

ServiceResourceStacksCollection#

Provides access to Stack resource.

Type annotations and code completion for boto3.resource("opsworks").stacks collection. boto3 documentation

# ServiceResourceStacksCollection usage example

from mypy_boto3_opsworks.service_resource import ServiceResourceStacksCollection

def get_collection() -> ServiceResourceStacksCollection:
    return boto3.resource("opsworks").stacks

Methods#

OpsWorksServiceResource.Layer method#

Creates a Layer resource.

Type annotations and code completion for boto3.resource("opsworks").Layer method. boto3 documentation

# Layer method definition

def Layer(
    self,
    id: str,
) -> Layer:
    ...

OpsWorksServiceResource.Stack method#

Creates a Stack resource.

Type annotations and code completion for boto3.resource("opsworks").Stack method. boto3 documentation

# Stack method definition

def Stack(
    self,
    id: str,
) -> Stack:
    ...

OpsWorksServiceResource.StackSummary method#

Creates a StackSummary resource.

Type annotations and code completion for boto3.resource("opsworks").StackSummary method. boto3 documentation

# StackSummary method definition

def StackSummary(
    self,
    stack_id: str,
) -> StackSummary:
    ...

OpsWorksServiceResource.create_stack method#

Creates a new stack.

Type annotations and code completion for boto3.resource("opsworks").create_stack method. boto3 documentation

# create_stack method definition

def create_stack(
    self,
    *,
    Name: str,
    Region: str,
    ServiceRoleArn: str,
    DefaultInstanceProfileArn: str,
    VpcId: str = ...,
    Attributes: Mapping[StackAttributesKeysType, str] = ...,  # (1)
    DefaultOs: str = ...,
    HostnameTheme: str = ...,
    DefaultAvailabilityZone: str = ...,
    DefaultSubnetId: str = ...,
    CustomJson: str = ...,
    ConfigurationManager: StackConfigurationManagerTypeDef = ...,  # (2)
    ChefConfiguration: ChefConfigurationTypeDef = ...,  # (3)
    UseCustomCookbooks: bool = ...,
    UseOpsworksSecurityGroups: bool = ...,
    CustomCookbooksSource: SourceTypeDef = ...,  # (4)
    DefaultSshKeyName: str = ...,
    DefaultRootDeviceType: RootDeviceTypeType = ...,  # (5)
    AgentVersion: str = ...,
) -> Stack:
    ...
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType
# create_stack method usage example with argument unpacking

kwargs: CreateStackRequestServiceResourceCreateStackTypeDef = {  # (1)
    "Name": ...,
    "Region": ...,
    "ServiceRoleArn": ...,
    "DefaultInstanceProfileArn": ...,
}

parent.create_stack(**kwargs)
  1. See CreateStackRequestServiceResourceCreateStackTypeDef

OpsWorksServiceResource.get_available_subresources method#

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("opsworks").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Layer#

Type annotations and code completion for boto3.resource("opsworks").Layer class. boto3 documentation

# Layer usage example

from mypy_boto3_opsworks.service_resource import Layer

def get_resource() -> Layer:
    return boto3.resource("opsworks").Layer(...)

Layer attributes#

Layer methods#

Layer.delete method#

Deletes a specified layer.

Type annotations and code completion for boto3.resource("opsworks").delete method. boto3 documentation

# delete method definition

def delete(
    self,
) -> None:
    ...

Layer.get_available_subresources method#

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("opsworks").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Layer.load method#

Calls 🇵🇾meth:OpsWorks.Client.describe_layers to update the attributes of the Layer resource.

Type annotations and code completion for boto3.resource("opsworks").load method. boto3 documentation

# load method definition

def load(
    self,
) -> None:
    ...

Layer.reload method#

Calls 🇵🇾meth:OpsWorks.Client.describe_layers to update the attributes of the Layer resource.

Type annotations and code completion for boto3.resource("opsworks").reload method. boto3 documentation

# reload method definition

def reload(
    self,
) -> None:
    ...

Stack#

Type annotations and code completion for boto3.resource("opsworks").Stack class. boto3 documentation

# Stack usage example

from mypy_boto3_opsworks.service_resource import Stack

def get_resource() -> Stack:
    return boto3.resource("opsworks").Stack(...)

Stack attributes#

Stack collections#

Stack.layers#

Provides access to Layer resource.

Type annotations and code completion for boto3.resource("opsworks").Stack(...).layers collection.