WorkloadState class

Input properties used for looking up and filtering Workload resources.

Constructors

WorkloadState({Input<String?>? billingAccount, Input<String?>? complianceRegime, Input<List<WorkloadComplianceStatus>?>? complianceStatuses, Input<List<String>?>? compliantButDisallowedServices, Input<String?>? createTime, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<Map<String, String>?>? effectiveLabels, Input<List<WorkloadEkmProvisioningResponse>?>? ekmProvisioningResponses, Input<bool?>? enableSovereignControls, Input<String?>? kajEnrollmentState, Input<WorkloadKmsSettings?>? kmsSettings, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? organization, Input<String?>? partner, Input<WorkloadPartnerPermissions?>? partnerPermissions, Input<String?>? partnerServicesBillingAccount, Input<String?>? provisionedResourcesParent, Input<Map<String, String>?>? pulumiLabels, Input<List<WorkloadResourceSetting>?>? resourceSettings, Input<List<WorkloadResource>?>? resources, Input<List<WorkloadSaaEnrollmentResponse>?>? saaEnrollmentResponses, Input<bool?>? violationNotificationsEnabled, Input<WorkloadWorkloadOptions?>? workloadOptions})

Creates a new WorkloadState. billingAccount Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF. complianceRegime Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT, KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS, REGIONAL_CONTROLS, HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS, HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT, IRS_1075 complianceStatuses Output only. Count of active Violations in the Workload. compliantButDisallowedServices Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke workloads.restrictAllowedResources endpoint to allow your project developers to use these services in their environment. createTime Output only. Immutable. The Workload creation timestamp. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". displayName Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. ekmProvisioningResponses Optional. Represents the Ekm Provisioning State of the given workload. enableSovereignControls Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. kajEnrollmentState Output only. Represents the KAJ enrollment state of the given workload. Possible values: KAJ_ENROLLMENT_STATE_UNSPECIFIED, KAJ_ENROLLMENT_STATE_PENDING, KAJ_ENROLLMENT_STATE_COMPLETE kmsSettings DEPRECATED Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. labels Optional. Labels applied to the workload. location The location for the resource name Output only. The resource name of the workload. organization The organization for the resource partner Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN, SOVEREIGN_CONTROLS_BY_CNTXT, SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM, SPAIN_DATA_BOUNDARY_BY_TELEFONICA partnerPermissions Optional. Permissions granted to the AW Partner SA account for the customer workload partnerServicesBillingAccount Optional. Input only. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC. provisionedResourcesParent Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} pulumiLabels The combination of labels configured directly on the resource and default labels configured on the provider. resourceSettings Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. resources Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. saaEnrollmentResponses Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during workloads.get call. In failure cases, user friendly error message is shown in SAA details page. violationNotificationsEnabled Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. workloadOptions Optional. Used to specify certain options for a workload during workload creation - currently only supporting KAT Optionality for Regional Controls workloads.

const

WorkloadState.fromMap(Map<String, dynamic> map)

factory

Properties

billingAccount → Input<String?>?

Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF.

final

complianceRegime → Input<String?>?

Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT, KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS, REGIONAL_CONTROLS, HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS, HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT, IRS_1075

final

complianceStatuses → Input<List<WorkloadComplianceStatus>?>?

Output only. Count of active Violations in the Workload.

final

compliantButDisallowedServices → Input<List<String>?>?

Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke workloads.restrictAllowedResources endpoint to allow your project developers to use these services in their environment.

final

createTime → Input<String?>?

Output only. Immutable. The Workload creation timestamp.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

displayName → Input<String?>?

Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload

final

effectiveLabels → Input<Map<String, String>?>?

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

final

ekmProvisioningResponses → Input<List<WorkloadEkmProvisioningResponse>?>?

Optional. Represents the Ekm Provisioning State of the given workload.

final

enableSovereignControls → Input<bool?>?

Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.

final

hashCode → int

The hash code for this object.

no setter, inherited

kajEnrollmentState → Input<String?>?

Output only. Represents the KAJ enrollment state of the given workload. Possible values: KAJ_ENROLLMENT_STATE_UNSPECIFIED, KAJ_ENROLLMENT_STATE_PENDING, KAJ_ENROLLMENT_STATE_COMPLETE

final

kmsSettings → Input<WorkloadKmsSettings?>?

DEPRECATED Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.

final

labels → Input<Map<String, String>?>?

Optional. Labels applied to the workload.

final

location → Input<String?>?

The location for the resource

final

name → Input<String?>?

Output only. The resource name of the workload.

final

organization → Input<String?>?

The organization for the resource

final

partner → Input<String?>?

Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN, SOVEREIGN_CONTROLS_BY_CNTXT, SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM, SPAIN_DATA_BOUNDARY_BY_TELEFONICA

final

partnerPermissions → Input<WorkloadPartnerPermissions?>?

Optional. Permissions granted to the AW Partner SA account for the customer workload

final

partnerServicesBillingAccount → Input<String?>?

Optional. Input only. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC.

final

provisionedResourcesParent → Input<String?>?

Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}

final

pulumiLabels → Input<Map<String, String>?>?

The combination of labels configured directly on the resource and default labels configured on the provider.

final

resources → Input<List<WorkloadResource>?>?

Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.

final

resourceSettings → Input<List<WorkloadResourceSetting>?>?

Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

saaEnrollmentResponses → Input<List<WorkloadSaaEnrollmentResponse>?>?

Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during workloads.get call. In failure cases, user friendly error message is shown in SAA details page.

final

violationNotificationsEnabled → Input<bool?>?

Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.

final

workloadOptions → Input<WorkloadWorkloadOptions?>?

Optional. Used to specify certain options for a workload during workload creation - currently only supporting KAT Optionality for Regional Controls workloads.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited