Struct aws_sdk_cloudformation::types::builders::StackEventBuilder

#[non_exhaustive]
pub struct StackEventBuilder { /* private fields */ }

A builder for StackEvent.

Implementations

impl StackEventBuilder

pub fn stack_id(self, input: impl Into<String>) -> Self

The unique ID name of the instance of the stack.

This field is required.

pub fn set_stack_id(self, input: Option<String>) -> Self

The unique ID name of the instance of the stack.

pub fn get_stack_id(&self) -> &Option<String>

The unique ID name of the instance of the stack.

pub fn event_id(self, input: impl Into<String>) -> Self

The unique ID of this event.

This field is required.

pub fn set_event_id(self, input: Option<String>) -> Self

The unique ID of this event.

pub fn get_event_id(&self) -> &Option<String>

The unique ID of this event.

pub fn stack_name(self, input: impl Into<String>) -> Self

The name associated with a stack.

This field is required.

pub fn set_stack_name(self, input: Option<String>) -> Self

The name associated with a stack.

pub fn get_stack_name(&self) -> &Option<String>

The name associated with a stack.

pub fn logical_resource_id(self, input: impl Into<String>) -> Self

The logical name of the resource specified in the template.

pub fn set_logical_resource_id(self, input: Option<String>) -> Self

The logical name of the resource specified in the template.

pub fn get_logical_resource_id(&self) -> &Option<String>

The logical name of the resource specified in the template.

pub fn physical_resource_id(self, input: impl Into<String>) -> Self

The name or unique identifier associated with the physical instance of the resource.

pub fn set_physical_resource_id(self, input: Option<String>) -> Self

The name or unique identifier associated with the physical instance of the resource.

pub fn get_physical_resource_id(&self) -> &Option<String>

The name or unique identifier associated with the physical instance of the resource.

pub fn resource_type(self, input: impl Into<String>) -> Self

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

pub fn set_resource_type(self, input: Option<String>) -> Self

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

pub fn get_resource_type(&self) -> &Option<String>

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

pub fn timestamp(self, input: DateTime) -> Self

Time the status was updated.

This field is required.

pub fn set_timestamp(self, input: Option<DateTime>) -> Self

Time the status was updated.

pub fn get_timestamp(&self) -> &Option<DateTime>

Time the status was updated.

pub fn resource_status(self, input: ResourceStatus) -> Self

Current status of the resource.

pub fn set_resource_status(self, input: Option<ResourceStatus>) -> Self

Current status of the resource.

pub fn get_resource_status(&self) -> &Option<ResourceStatus>

Current status of the resource.

pub fn resource_status_reason(self, input: impl Into<String>) -> Self

Success/failure message associated with the resource.

pub fn set_resource_status_reason(self, input: Option<String>) -> Self

Success/failure message associated with the resource.

pub fn get_resource_status_reason(&self) -> &Option<String>

Success/failure message associated with the resource.

pub fn resource_properties(self, input: impl Into<String>) -> Self

BLOB of the properties used to create the resource.

pub fn set_resource_properties(self, input: Option<String>) -> Self

BLOB of the properties used to create the resource.

pub fn get_resource_properties(&self) -> &Option<String>

BLOB of the properties used to create the resource.

pub fn client_request_token(self, input: impl Into<String>) -> Self

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

pub fn set_client_request_token(self, input: Option<String>) -> Self

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

pub fn get_client_request_token(&self) -> &Option<String>

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

pub fn hook_type(self, input: impl Into<String>) -> Self

The name of the hook.

pub fn set_hook_type(self, input: Option<String>) -> Self

The name of the hook.

pub fn get_hook_type(&self) -> &Option<String>

The name of the hook.

pub fn hook_status(self, input: HookStatus) -> Self

Provides the status of the change set hook.

pub fn set_hook_status(self, input: Option<HookStatus>) -> Self

Provides the status of the change set hook.

pub fn get_hook_status(&self) -> &Option<HookStatus>

Provides the status of the change set hook.

pub fn hook_status_reason(self, input: impl Into<String>) -> Self

Provides the reason for the hook status.

pub fn set_hook_status_reason(self, input: Option<String>) -> Self

Provides the reason for the hook status.

pub fn get_hook_status_reason(&self) -> &Option<String>

Provides the reason for the hook status.

pub fn hook_invocation_point(self, input: HookInvocationPoint) -> Self

Invocation points are points in provisioning logic where hooks are initiated.

pub fn set_hook_invocation_point( self, input: Option<HookInvocationPoint> ) -> Self

Invocation points are points in provisioning logic where hooks are initiated.

pub fn get_hook_invocation_point(&self) -> &Option<HookInvocationPoint>

Invocation points are points in provisioning logic where hooks are initiated.

pub fn hook_failure_mode(self, input: HookFailureMode) -> Self

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.

• WARN Allows provisioning to continue with a warning message.

pub fn set_hook_failure_mode(self, input: Option<HookFailureMode>) -> Self

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.

• WARN Allows provisioning to continue with a warning message.

pub fn get_hook_failure_mode(&self) -> &Option<HookFailureMode>

Specify the hook failure mode for non-compliant resources in the followings ways.

• FAIL Stops provisioning resources.

• WARN Allows provisioning to continue with a warning message.

pub fn detailed_status(self, input: DetailedStatus) -> Self

An optional field containing information about the detailed status of the stack event.

• CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

• VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

pub fn set_detailed_status(self, input: Option<DetailedStatus>) -> Self

An optional field containing information about the detailed status of the stack event.

• CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

• VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

pub fn get_detailed_status(&self) -> &Option<DetailedStatus>

An optional field containing information about the detailed status of the stack event.

• CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

• VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

pub fn build(self) -> StackEvent

Consumes the builder and constructs a StackEvent.

Trait Implementations

impl Clone for StackEventBuilder

fn clone(&self) -> StackEventBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StackEventBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StackEventBuilder

fn default() -> StackEventBuilder

Returns the “default value” for a type.

impl PartialEq for StackEventBuilder

fn eq(&self, other: &StackEventBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StackEventBuilder