Skip to content

create_policy

create_policy(
    name: EntityName,
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    description: Optional[LongDescription] = None,
    availability_slo: Optional[AvailabilitySlo] = None,
    multi_az: Optional[MultiAzTargets] = None,
    multi_region: Optional[MultiRegionTargets] = None,
    data_recovery: Optional[DataRecoveryTargets] = None,
    sharing_enabled: Optional[bool] = None,
    kms_key_id: Optional[KmsKeyId] = None,
    tags: Optional[TagMap] = None,
    client_token: Optional[ClientToken] = None,
) -> CreatePolicyResponse

Creates a resilience policy that defines availability and disaster recovery requirements.

Parameters:

  • availability_slo (Optional[AvailabilitySlo], default: None ) –

    The availability SLO for the resilience policy.

  • multi_az (Optional[MultiAzTargets], default: None ) –

    The multi-AZ disaster recovery targets for the resilience policy.

  • multi_region (Optional[MultiRegionTargets], default: None ) –

    The multi-Region disaster recovery targets for the resilience policy.

  • data_recovery (Optional[DataRecoveryTargets], default: None ) –

    The data recovery targets for the resilience policy.

  • sharing_enabled (Optional[bool], default: None ) –

    Specifies whether cross-account sharing is enabled for the policy. Only a delegated administrator or the management account can enable sharing.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/resiliencehubv2.py
def create_policy(
    self,
    name: "capo_resiliencehubv2.types.entity_name.EntityName",
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    description: Optional[
        "capo_resiliencehubv2.types.long_description.LongDescription"
    ] = None,
    availability_slo: Optional[
        "capo_resiliencehubv2.types.availability_slo.AvailabilitySlo"
    ] = None,
    multi_az: Optional[
        "capo_resiliencehubv2.types.multi_az_targets.MultiAzTargets"
    ] = None,
    multi_region: Optional[
        "capo_resiliencehubv2.types.multi_region_targets.MultiRegionTargets"
    ] = None,
    data_recovery: Optional[
        "capo_resiliencehubv2.types.data_recovery_targets.DataRecoveryTargets"
    ] = None,
    sharing_enabled: Optional[bool] = None,
    kms_key_id: Optional["capo_resiliencehubv2.types.kms_key_id.KmsKeyId"] = None,
    tags: Optional["capo_resiliencehubv2.types.tag_map.TagMap"] = None,
    client_token: Optional[
        "capo_resiliencehubv2.types.client_token.ClientToken"
    ] = None,
) -> "capo_resiliencehubv2.types.create_policy_response.CreatePolicyResponse":
    """<p>Creates a resilience policy that defines availability and disaster recovery requirements.</p>

    Args:
        availability_slo: <p>The availability SLO for the resilience policy.</p>
        multi_az: <p>The multi-AZ disaster recovery targets for the resilience policy.</p>
        multi_region: <p>The multi-Region disaster recovery targets for the resilience policy.</p>
        data_recovery: <p>The data recovery targets for the resilience policy.</p>
        sharing_enabled: <p>Specifies whether cross-account sharing is enabled for the policy. Only a delegated administrator or the management account can enable sharing.</p>

    Raises:
        capo_resiliencehubv2.errors.access_denied_exception.AccessDeniedException: <p>Access denied — caller lacks required permissions.</p>
        capo_resiliencehubv2.errors.conflict_exception.ConflictException: <p>Conflict — resource already exists.</p>
        capo_resiliencehubv2.errors.internal_server_exception.InternalServerException: <p>Internal service error.</p>
        capo_resiliencehubv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_resiliencehubv2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Service quota exceeded.</p>
        capo_resiliencehubv2.errors.validation_exception.ValidationException: <p>Validation error — invalid input parameters.</p>
        capo_resiliencehubv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_resiliencehubv2.types.create_policy_request.CreatePolicyRequest]",
    ) -> OperationResponse[
        "capo_resiliencehubv2.types.create_policy_response.CreatePolicyResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.create_policy

        output, http_response = (
            capo_resiliencehubv2._operations.ngrh_service_core.create_policy.create_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_resiliencehubv2.types.create_policy_request.CreatePolicyRequest",
    ) -> dict[str, Any]:
        import capo_resiliencehubv2.types.create_policy_request

        return capo_resiliencehubv2.types.create_policy_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_resiliencehubv2.types.create_policy_response.CreatePolicyResponse",
    ) -> dict[str, Any]:
        import capo_resiliencehubv2.types.create_policy_response

        return capo_resiliencehubv2.types.create_policy_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreatePolicy", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_resiliencehubv2.types.create_policy_request.CreatePolicyRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if availability_slo is not None:
        input_["availability_slo"] = availability_slo
    if multi_az is not None:
        input_["multi_az"] = multi_az
    if multi_region is not None:
        input_["multi_region"] = multi_region
    if data_recovery is not None:
        input_["data_recovery"] = data_recovery
    if sharing_enabled is not None:
        input_["sharing_enabled"] = sharing_enabled
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output