CloudFormationServiceResource#
Index > CloudFormation > CloudFormationServiceResource
Auto-generated documentation for CloudFormation type annotations stubs module types-aiobotocore-cloudformation.
CloudFormationServiceResource#
Type annotations and code completion for session.resource("cloudformation")
, included resources and collections.
boto3 documentation
# CloudFormationServiceResource usage example
from types_aiobotocore_cloudformation.service_resource import CloudFormationServiceResource
def get_cloudformation_resource() -> CloudFormationServiceResource:
return session.resource("cloudformation")
Attributes#
-
stacks
: ServiceResourceStacksCollection
Collections#
ServiceResourceStacksCollection#
Provides access to Stack resource.
Type annotations and code completion for session.resource("cloudformation").stacks
collection.
boto3 documentation
# ServiceResourceStacksCollection usage example
from types_aiobotocore_cloudformation.service_resource import ServiceResourceStacksCollection
def get_collection() -> ServiceResourceStacksCollection:
return session.resource("cloudformation").stacks
Methods#
CloudFormationServiceResource.Event method#
Creates a Event resource.
Type annotations and code completion for session.resource("cloudformation").Event
method.
boto3 documentation
# Event method definition
await def Event(
self,
id: str,
) -> Event:
...
CloudFormationServiceResource.Stack method#
Creates a Stack resource.
Type annotations and code completion for session.resource("cloudformation").Stack
method.
boto3 documentation
# Stack method definition
await def Stack(
self,
name: str,
) -> Stack:
...
CloudFormationServiceResource.StackResource method#
Creates a StackResource resource.
Type annotations and code completion for session.resource("cloudformation").StackResource
method.
boto3 documentation
# StackResource method definition
await def StackResource(
self,
stack_name: str,
logical_id: str,
) -> StackResource:
...
CloudFormationServiceResource.StackResourceSummary method#
Creates a StackResourceSummary resource.
Type annotations and code completion for session.resource("cloudformation").StackResourceSummary
method.
boto3 documentation
# StackResourceSummary method definition
await def StackResourceSummary(
self,
stack_name: str,
logical_id: str,
) -> StackResourceSummary:
...
CloudFormationServiceResource.create_stack method#
Creates a stack as specified in the template.
Type annotations and code completion for session.resource("cloudformation").create_stack
method.
boto3 documentation
# create_stack method definition
await 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:
...
- See ParameterTypeDef
- See RollbackConfigurationTypeDef
- See CapabilityType
- See OnFailureType
- See TagTypeDef
# create_stack method usage example with argument unpacking
kwargs: CreateStackInputServiceResourceCreateStackTypeDef = { # (1)
"StackName": ...,
}
parent.create_stack(**kwargs)
CloudFormationServiceResource.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for session.resource("cloudformation").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Event#
Type annotations and code completion for session.resource("cloudformation").Event
class.
boto3 documentation
# Event usage example
from types_aiobotocore_cloudformation.service_resource import Event
def get_resource() -> Event:
return session.resource("cloudformation").Event(...)
Event attributes#
stack_id
:Awaitable
[str
]event_id
:Awaitable
[str
]stack_name
:Awaitable
[str
]logical_resource_id
:Awaitable
[str
]physical_resource_id
:Awaitable
[str
]resource_type
:Awaitable
[str
]timestamp
:Awaitable
[datetime
]resource_status
:Awaitable
[ResourceStatusType]resource_status_reason
:Awaitable
[str
]resource_properties
:Awaitable
[str
]client_request_token
:Awaitable
[str
]hook_type
:Awaitable
[str
]hook_status
:Awaitable
[HookStatusType]hook_status_reason
:Awaitable
[str
]hook_invocation_point
:Awaitable
[Literal['PRE_PROVISION']
(see HookInvocationPointType)]hook_failure_mode
:Awaitable
[HookFailureModeType]id
:str
Event methods#
Event.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Stack#
Type annotations and code completion for session.resource("cloudformation").Stack
class.
boto3 documentation
# Stack usage example
from types_aiobotocore_cloudformation.service_resource import Stack
def get_resource() -> Stack:
return session.resource("cloudformation").Stack(...)
Stack attributes#
stack_id
:Awaitable
[str
]stack_name
:Awaitable
[str
]change_set_id
:Awaitable
[str
]description
:Awaitable
[str
]parameters
:Awaitable
[List
[ParameterTypeDef]]creation_time
:Awaitable
[datetime
]deletion_time
:Awaitable
[datetime
]last_updated_time
:Awaitable
[datetime
]rollback_configuration
:Awaitable
[RollbackConfigurationResponseTypeDef]stack_status
:Awaitable
[StackStatusType]stack_status_reason
:Awaitable
[str
]disable_rollback
:Awaitable
[bool
]notification_arns
:Awaitable
[List
[str
]]timeout_in_minutes
:Awaitable
[int
]capabilities
:Awaitable
[List
[CapabilityType]]outputs
:Awaitable
[List
[OutputTypeDef]]role_arn
:Awaitable
[str
]tags
:Awaitable
[List
[TagTypeDef]]enable_termination_protection
:Awaitable
[bool
]parent_id
:Awaitable
[str
]root_id
:Awaitable
[str
]drift_information
:Awaitable
[StackDriftInformationResponseTypeDef]retain_except_on_create
:Awaitable
[bool
]name
:str
events
: StackEventsCollectionresource_summaries
: StackResourceSummariesCollection
Stack collections#
Stack.events#
Provides access to Event resource.
Type annotations and code completion for session.resource("cloudformation").Stack(...).events
collection.
boto3 documentation
# StackEventsCollection usage example
from types_aiobotocore_cloudformation.service_resource import StackEventsCollection
def get_collection() -> StackEventsCollection:
resource = session.resource("cloudformation").Stack(...)
return resource.events
Stack.resource_summaries#
Provides access to StackResourceSummary resource.
Type annotations and code completion for session.resource("cloudformation").Stack(...).resource_summaries
collection.
boto3 documentation
# StackResourceSummariesCollection usage example
from types_aiobotocore_cloudformation.service_resource import StackResourceSummariesCollection
def get_collection() -> StackResourceSummariesCollection:
resource = session.resource("cloudformation").Stack(...)
return resource.resource_summaries
Stack methods#
Stack.Resource method#
Creates a StackResource resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").Resource
method.
boto3 documentation
# Resource method definition
await def Resource(
self,
logical_id: str,
) -> StackResource:
...
Stack.cancel_update method#
Cancels an update on the specified stack.
Type annotations and code completion for aiobotocore.resource("cloudformation").cancel_update
method.
boto3 documentation
# cancel_update method definition
await def cancel_update(
self,
*,
ClientRequestToken: str = ...,
) -> None:
...
# cancel_update method usage example with argument unpacking
kwargs: CancelUpdateStackInputStackCancelUpdateTypeDef = { # (1)
"ClientRequestToken": ...,
}
parent.cancel_update(**kwargs)
Stack.delete method#
Deletes a specified stack.
Type annotations and code completion for aiobotocore.resource("cloudformation").delete
method.
boto3 documentation
# delete method definition
await def delete(
self,
*,
RetainResources: Sequence[str] = ...,
RoleARN: str = ...,
ClientRequestToken: str = ...,
) -> None:
...
# delete method usage example with argument unpacking
kwargs: DeleteStackInputStackDeleteTypeDef = { # (1)
"RetainResources": ...,
}
parent.delete(**kwargs)
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("cloudformation").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Stack.load method#
Calls meth:CloudFormation.Client.describe_stacks
to update the attributes
of the Stack resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
Stack.reload method#
Calls meth:CloudFormation.Client.describe_stacks
to update the attributes
of the Stack resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
Stack.update method#
Updates a stack as specified in the template.
Type annotations and code completion for aiobotocore.resource("cloudformation").update
method.
boto3 documentation
# update method definition
await 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)
...
- See ParameterTypeDef
- See CapabilityType
- See RollbackConfigurationTypeDef
- See TagTypeDef
- See UpdateStackOutputTypeDef
# update method usage example with argument unpacking
kwargs: UpdateStackInputStackUpdateTypeDef = { # (1)
"TemplateBody": ...,
}
parent.update(**kwargs)
StackResource#
Type annotations and code completion for session.resource("cloudformation").StackResource
class.
boto3 documentation
# StackResource usage example
from types_aiobotocore_cloudformation.service_resource import StackResource
def get_resource() -> StackResource:
return session.resource("cloudformation").StackResource(...)
StackResource attributes#
stack_id
:Awaitable
[str
]logical_resource_id
:Awaitable
[str
]physical_resource_id
:Awaitable
[str
]resource_type
:Awaitable
[str
]last_updated_timestamp
:Awaitable
[datetime
]resource_status
:Awaitable
[ResourceStatusType]resource_status_reason
:Awaitable
[str
]description
:Awaitable
[str
]metadata
:Awaitable
[str
]drift_information
:Awaitable
[StackResourceDriftInformationResponseTypeDef]module_info
:Awaitable
[ModuleInfoTypeDef]stack_name
:str
logical_id
:str
StackResource methods#
StackResource.Stack method#
Creates a Stack resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").Stack
method.
boto3 documentation
# Stack method definition
await def Stack(
self,
) -> Stack:
...
StackResource.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
StackResource.load method#
Calls meth:CloudFormation.Client.describe_stack_resource
to update the
attributes of the StackResource resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").load
method.
boto3 documentation
# load method definition
await def load(
self,
) -> None:
...
StackResource.reload method#
Calls meth:CloudFormation.Client.describe_stack_resource
to update the
attributes of the StackResource resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
StackResourceSummary#
Type annotations and code completion for session.resource("cloudformation").StackResourceSummary
class.
boto3 documentation
# StackResourceSummary usage example
from types_aiobotocore_cloudformation.service_resource import StackResourceSummary
def get_resource() -> StackResourceSummary:
return session.resource("cloudformation").StackResourceSummary(...)
StackResourceSummary attributes#
logical_resource_id
:Awaitable
[str
]physical_resource_id
:Awaitable
[str
]resource_type
:Awaitable
[str
]last_updated_timestamp
:Awaitable
[datetime
]resource_status
:Awaitable
[ResourceStatusType]resource_status_reason
:Awaitable
[str
]drift_information
:Awaitable
[StackResourceDriftInformationSummaryResponseTypeDef]module_info
:Awaitable
[ModuleInfoResponseTypeDef]stack_name
:str
logical_id
:str
StackResourceSummary methods#
StackResourceSummary.Resource method#
Creates a StackResource resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").Resource
method.
boto3 documentation
# Resource method definition
await def Resource(
self,
) -> StackResource:
...
StackResourceSummary.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("cloudformation").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...