OpsWorksServiceResource

Index > OpsWorks > OpsWorksServiceResource

Auto-generated documentation for OpsWorks type annotations stubs module types-aiobotocore-opsworks.

OpsWorksServiceResource

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

# OpsWorksServiceResource usage example

from types_aiobotocore_opsworks.service_resource import OpsWorksServiceResource

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

Attributes

• meta: OpsWorksResourceMeta

• stacks: ServiceResourceStacksCollection

Collections

ServiceResourceStacksCollection

Provides access to Stack resource.

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

# ServiceResourceStacksCollection usage example

from types_aiobotocore_opsworks.service_resource import ServiceResourceStacksCollection

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

Methods

OpsWorksServiceResource.Layer method

Creates a Layer resource.

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

# Layer method definition

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

OpsWorksServiceResource.Stack method

Creates a Stack resource.

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

# Stack method definition

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

OpsWorksServiceResource.StackSummary method

Creates a StackSummary resource.

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

# StackSummary method definition

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

OpsWorksServiceResource.create_stack method

Creates a new stack.

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

# create_stack method definition

await 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 session.resource("opsworks").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

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

Layer

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

# Layer usage example

from types_aiobotocore_opsworks.service_resource import Layer

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

Layer attributes

• arn: Awaitable[str]
• stack_id: Awaitable[str]
• layer_id: Awaitable[str]
• type: Awaitable[LayerTypeType]
• name: Awaitable[str]
• shortname: Awaitable[str]
• attributes: Awaitable[Dict[LayerAttributesKeysType, str]]
• cloud_watch_logs_configuration: Awaitable[CloudWatchLogsConfigurationResponseTypeDef]
• custom_instance_profile_arn: Awaitable[str]
• custom_json: Awaitable[str]
• custom_security_group_ids: Awaitable[List[str]]
• default_security_group_names: Awaitable[List[str]]
• packages: Awaitable[List[str]]
• volume_configurations: Awaitable[List[VolumeConfigurationTypeDef]]
• enable_auto_healing: Awaitable[bool]
• auto_assign_elastic_ips: Awaitable[bool]
• auto_assign_public_ips: Awaitable[bool]
• default_recipes: Awaitable[RecipesResponseTypeDef]
• custom_recipes: Awaitable[RecipesResponseTypeDef]
• created_at: Awaitable[str]
• install_updates_on_boot: Awaitable[bool]
• use_ebs_optimized_instances: Awaitable[bool]
• lifecycle_event_configuration: Awaitable[LifecycleEventConfigurationResponseTypeDef]
• id: str
• stack: Stack

Layer methods

Layer.delete method

Deletes a specified layer.

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

# delete method definition

await 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 aiobotocore.resource("opsworks").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

await 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 aiobotocore.resource("opsworks").load method. boto3 documentation

# load method definition

await 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 aiobotocore.resource("opsworks").reload method. boto3 documentation

# reload method definition

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

Stack

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

# Stack usage example

from types_aiobotocore_opsworks.service_resource import Stack

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

Stack attributes

• stack_id: Awaitable[str]
• name: Awaitable[str]
• arn: Awaitable[str]
• region: Awaitable[str]
• vpc_id: Awaitable[str]
• attributes: Awaitable[Dict[Literal['Color'] (see StackAttributesKeysType), str]]
• service_role_arn: Awaitable[str]
• default_instance_profile_arn: Awaitable[str]
• default_os: Awaitable[str]
• hostname_theme: Awaitable[str]
• default_availability_zone: Awaitable[str]
• default_subnet_id: Awaitable[str]
• custom_json: Awaitable[str]
• configuration_manager: Awaitable[StackConfigurationManagerResponseTypeDef]
• chef_configuration: Awaitable[ChefConfigurationResponseTypeDef]
• use_custom_cookbooks: Awaitable[bool]
• use_opsworks_security_groups: Awaitable[bool]
• custom_cookbooks_source: Awaitable[SourceResponseTypeDef]
• default_ssh_key_name: Awaitable[str]
• created_at: Awaitable[str]
• default_root_device_type: Awaitable[RootDeviceTypeType]
• agent_version: Awaitable[str]
• id: str
• layers: StackLayersCollection

Stack collections

Stack.layers

Provides access to Layer resource.

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

# StackLayersCollection usage example

from types_aiobotocore_opsworks.service_resource import StackLayersCollection

def get_collection() -> StackLayersCollection:
    resource = session.resource("opsworks").Stack(...)
    return resource.layers

Stack methods

Stack.Summary method

Creates a StackSummary resource.

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

# Summary method definition

await def Summary(
    self,
) -> StackSummary:
    ...

Stack.create_layer method

Creates a layer.

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

# create_layer method definition

await def create_layer(
    self,
    *,
    Type: LayerTypeType,  # (1)
    Name: str,
    Shortname: str,
    Attributes: Mapping[LayerAttributesKeysType, str] = ...,  # (2)
    CloudWatchLogsConfiguration: CloudWatchLogsConfigurationTypeDef = ...,  # (3)
    CustomInstanceProfileArn: str = ...,
    CustomJson: str = ...,
    CustomSecurityGroupIds: Sequence[str] = ...,
    Packages: Sequence[str] = ...,
    VolumeConfigurations: Sequence[VolumeConfigurationTypeDef] = ...,  # (4)
    EnableAutoHealing: bool = ...,
    AutoAssignElasticIps: bool = ...,
    AutoAssignPublicIps: bool = ...,
    CustomRecipes: RecipesTypeDef = ...,  # (5)
    InstallUpdatesOnBoot: bool = ...,
    UseEbsOptimizedInstances: bool = ...,
    LifecycleEventConfiguration: LifecycleEventConfigurationTypeDef = ...,  # (6)
) -> Layer:
    ...

1. See LayerTypeType
2. See LayerAttributesKeysType
3. See CloudWatchLogsConfigurationTypeDef
4. See VolumeConfigurationTypeDef
5. See RecipesTypeDef
6. See LifecycleEventConfigurationTypeDef

# create_layer method usage example with argument unpacking

kwargs: CreateLayerRequestStackCreateLayerTypeDef = {  # (1)
    "Type": ...,
    "Name": ...,
    "Shortname": ...,
}

parent.create_layer(**kwargs)

1. See CreateLayerRequestStackCreateLayerTypeDef

Stack.delete method

Deletes a specified stack.

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

# delete method definition

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

Stack.get_available_subresources method

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

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

# get_available_subresources method definition

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

Stack.load method

Calls meth:OpsWorks.Client.describe_stacks to update the attributes of the Stack resource.

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

# load method definition

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

Stack.reload method

Calls meth:OpsWorks.Client.describe_stacks to update the attributes of the Stack resource.

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

# reload method definition

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

StackSummary

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

# StackSummary usage example

from types_aiobotocore_opsworks.service_resource import StackSummary

def get_resource() -> StackSummary:
    return session.resource("opsworks").StackSummary(...)

StackSummary attributes

• name: Awaitable[str]
• arn: Awaitable[str]
• layers_count: Awaitable[int]
• apps_count: Awaitable[int]
• instances_count: Awaitable[InstancesCountResponseTypeDef]
• stack_id: str

StackSummary methods

StackSummary.Stack method

Creates a Stack resource.

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

# Stack method definition

await def Stack(
    self,
) -> Stack:
    ...

StackSummary.get_available_subresources method

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

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

# get_available_subresources method definition

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

StackSummary.load method

Calls meth:OpsWorks.Client.describe_stack_summary to update the attributes of the StackSummary resource.

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

# load method definition

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

StackSummary.reload method

Calls meth:OpsWorks.Client.describe_stack_summary to update the attributes of the StackSummary resource.

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

# reload method definition

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