CloudFormationServiceResource

Index > CloudFormation > CloudFormationServiceResource

Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.

CloudFormationServiceResource

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

# CloudFormationServiceResource usage example

from mypy_boto3_cloudformation.service_resource import CloudFormationServiceResource

def get_cloudformation_resource() -> CloudFormationServiceResource:
    return boto3.resource("cloudformation")

Attributes

• meta: CloudFormationResourceMeta

• stacks: ServiceResourceStacksCollection

Collections

ServiceResourceStacksCollection

Provides access to Stack resource.

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

# ServiceResourceStacksCollection usage example

from mypy_boto3_cloudformation.service_resource import ServiceResourceStacksCollection

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

Methods

CloudFormationServiceResource.get_available_subresources method

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

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

# get_available_subresources method definition

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

CloudFormationServiceResource.create_stack method

Creates a stack as specified in the template.

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

# create_stack method definition

def create_stack(
    self,
    *,
    StackName: str,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    DisableRollback: bool = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (2)
    TimeoutInMinutes: int = ...,
    NotificationARNs: Sequence[str] = ...,
    Capabilities: Sequence[CapabilityType] = ...,  # (3)
    ResourceTypes: Sequence[str] = ...,
    RoleARN: str = ...,
    OnFailure: OnFailureType = ...,  # (4)
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    ClientRequestToken: str = ...,
    EnableTerminationProtection: bool = ...,
    RetainExceptOnCreate: bool = ...,
) -> _Stack:
    ...

1. See ParameterTypeDef
2. See RollbackConfigurationTypeDef
3. See CapabilityType
4. See OnFailureType
5. See TagTypeDef

# create_stack method usage example with argument unpacking

kwargs: CreateStackInputServiceResourceCreateStackTypeDef = {  # (1)
    "StackName": ...,
}

parent.create_stack(**kwargs)

1. See CreateStackInputServiceResourceCreateStackTypeDef

CloudFormationServiceResource.Event method

Creates a Event resource.

Type annotations and code completion for boto3.resource("cloudformation").Event method. boto3 documentation

# Event method definition

def Event(
    self,
    id: str,
) -> _Event:
    ...

CloudFormationServiceResource.Stack method

Creates a Stack resource.

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

# Stack method definition

def Stack(
    self,
    name: str,
) -> _Stack:
    ...

CloudFormationServiceResource.StackResource method

Creates a StackResource resource.

Type annotations and code completion for boto3.resource("cloudformation").StackResource method. boto3 documentation

# StackResource method definition

def StackResource(
    self,
    stack_name: str,
    logical_id: str,
) -> _StackResource:
    ...

CloudFormationServiceResource.StackResourceSummary method

Creates a StackResourceSummary resource.

Type annotations and code completion for boto3.resource("cloudformation").StackResourceSummary method. boto3 documentation

# StackResourceSummary method definition

def StackResourceSummary(
    self,
    stack_name: str,
    logical_id: str,
) -> _StackResourceSummary:
    ...

Event

Type annotations and code completion for boto3.resource("cloudformation").Event class. boto3 documentation

# Event usage example

from mypy_boto3_cloudformation.service_resource import Event

def get_resource() -> Event:
    return boto3.resource("cloudformation").Event(...)

Event attributes

• id: str
• stack_id: str
• event_id: str
• stack_name: str
• logical_resource_id: str
• physical_resource_id: str
• resource_type: str
• timestamp: datetime
• resource_status: ResourceStatusType
• resource_status_reason: str
• resource_properties: str
• client_request_token: str
• hook_type: str
• hook_status: HookStatusType
• hook_status_reason: str
• hook_invocation_point: Literal['PRE_PROVISION'] (see HookInvocationPointType)
• hook_failure_mode: HookFailureModeType
• detailed_status: DetailedStatusType
• meta: CloudFormationResourceMeta

Event methods

Event.get_available_subresources method

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

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

# get_available_subresources method definition

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

Stack

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

# Stack usage example

from mypy_boto3_cloudformation.service_resource import Stack

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

Stack attributes

• name: str
• events: StackEventsCollection
• resource_summaries: StackResourceSummariesCollection
• stack_id: str
• stack_name: str
• change_set_id: str
• description: str
• parameters: list[ParameterTypeDef]
• creation_time: datetime
• deletion_time: datetime
• last_updated_time: datetime
• rollback_configuration: RollbackConfigurationOutputTypeDef
• stack_status: StackStatusType
• stack_status_reason: str
• disable_rollback: bool
• notification_arns: list[str]
• timeout_in_minutes: int
• capabilities: list[CapabilityType]
• outputs: list[OutputTypeDef]
• role_arn: str
• tags: list[TagTypeDef]
• enable_termination_protection: bool
• parent_id: str
• root_id: str
• drift_information: StackDriftInformationTypeDef
• retain_except_on_create: bool
• deletion_mode: DeletionModeType
• detailed_status: DetailedStatusType
• meta: CloudFormationResourceMeta

Stack collections

Stack.events

Provides access to Event resource.

Type annotations and code completion for boto3.resource("cloudformation").Stack(...).events collection. boto3 documentation

# StackEventsCollection usage example

from mypy_boto3_cloudformation.service_resource import StackEventsCollection

def get_collection() -> StackEventsCollection:
    resource = boto3.resource("cloudformation").Stack(...)
    return resource.events

Stack.resource_summaries

Provides access to StackResourceSummary resource.

Type annotations and code completion for boto3.resource("cloudformation").Stack(...).resource_summaries collection. boto3 documentation

# StackResourceSummariesCollection usage example

from mypy_boto3_cloudformation.service_resource import StackResourceSummariesCollection

def get_collection() -> StackResourceSummariesCollection:
    resource = boto3.resource("cloudformation").Stack(...)
    return resource.resource_summaries

Stack methods

Stack.get_available_subresources method

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

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

# get_available_subresources method definition

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

Stack.cancel_update method

Cancels an update on the specified stack.

Type annotations and code completion for boto3.resource("cloudformation").cancel_update method. boto3 documentation

# cancel_update method definition

def cancel_update(
    self,
    *,
    ClientRequestToken: str = ...,
) -> None:
    ...

# cancel_update method usage example with argument unpacking

kwargs: CancelUpdateStackInputStackCancelUpdateTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.cancel_update(**kwargs)

1. See CancelUpdateStackInputStackCancelUpdateTypeDef

Stack.delete method

Deletes a specified stack.

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

# delete method definition

def delete(
    self,
    *,
    RetainResources: Sequence[str] = ...,
    RoleARN: str = ...,
    ClientRequestToken: str = ...,
    DeletionMode: DeletionModeType = ...,  # (1)
) -> None:
    ...

1. See DeletionModeType

# delete method usage example with argument unpacking

kwargs: DeleteStackInputStackDeleteTypeDef = {  # (1)
    "RetainResources": ...,
}

parent.delete(**kwargs)

1. See DeleteStackInputStackDeleteTypeDef

Stack.update method

Updates a stack as specified in the template.

Type annotations and code completion for boto3.resource("cloudformation").update method. boto3 documentation

# update method definition

def update(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    UsePreviousTemplate: bool = ...,
    StackPolicyDuringUpdateBody: str = ...,
    StackPolicyDuringUpdateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    Capabilities: Sequence[CapabilityType] = ...,  # (2)
    ResourceTypes: Sequence[str] = ...,
    RoleARN: str = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (3)
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
    NotificationARNs: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    DisableRollback: bool = ...,
    ClientRequestToken: str = ...,
    RetainExceptOnCreate: bool = ...,
) -> UpdateStackOutputTypeDef:  # (5)
    ...

1. See ParameterTypeDef
2. See CapabilityType
3. See RollbackConfigurationTypeDef
4. See TagTypeDef
5. See UpdateStackOutputTypeDef

# update method usage example with argument unpacking

kwargs: UpdateStackInputStackUpdateTypeDef = {  # (1)
    "TemplateBody": ...,
}

parent.update(**kwargs)

1. See UpdateStackInputStackUpdateTypeDef

Stack.Resource method

Creates a StackResource resource.

Type annotations and code completion for boto3.resource("cloudformation").Resource method. boto3 documentation

# Resource method definition

def Resource(
    self,
    logical_id: str,
) -> _StackResource:
    ...

Stack.load method

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

# load method definition

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

Stack.reload method

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

# reload method definition

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

StackResource

Type annotations and code completion for boto3.resource("cloudformation").StackResource class. boto3 documentation

# StackResource usage example

from mypy_boto3_cloudformation.service_resource import StackResource

def get_resource() -> StackResource:
    return boto3.resource("cloudformation").StackResource(...)

StackResource attributes

• stack_name: str
• logical_id: str
• stack_id: str
• logical_resource_id: str
• physical_resource_id: str
• resource_type: str
• last_updated_timestamp: datetime
• resource_status: ResourceStatusType
• resource_status_reason: str
• description: str
• metadata: str
• drift_information: StackResourceDriftInformationTypeDef
• module_info: ModuleInfoTypeDef
• meta: CloudFormationResourceMeta

StackResource methods

StackResource.get_available_subresources method

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

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

# get_available_subresources method definition

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

StackResource.Stack method

Creates a Stack resource.

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

# Stack method definition

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

StackResource.load method

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

# load method definition

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

StackResource.reload method

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

# reload method definition

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

StackResourceSummary

Type annotations and code completion for boto3.resource("cloudformation").StackResourceSummary class. boto3 documentation

# StackResourceSummary usage example

from mypy_boto3_cloudformation.service_resource import StackResourceSummary

def get_resource() -> StackResourceSummary:
    return boto3.resource("cloudformation").StackResourceSummary(...)

StackResourceSummary attributes

• stack_name: str
• logical_id: str
• logical_resource_id: str
• physical_resource_id: str
• resource_type: str
• last_updated_timestamp: datetime
• resource_status: ResourceStatusType
• resource_status_reason: str
• drift_information: StackResourceDriftInformationSummaryTypeDef
• module_info: ModuleInfoTypeDef
• meta: CloudFormationResourceMeta

StackResourceSummary methods

StackResourceSummary.get_available_subresources method

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

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

# get_available_subresources method definition

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

StackResourceSummary.Resource method

Creates a StackResource resource.

Type annotations and code completion for boto3.resource("cloudformation").Resource method. boto3 documentation

# Resource method definition

def Resource(
    self,
) -> _StackResource:
    ...