Skip to content
v2.277.0

CfnAgentOrganizationalProfileProps Struct Added in v2.277.0 ​

Properties for defining a CfnAgentOrganizationalProfile.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wellarchitected as wellarchitected } from 'aws-cdk-lib';
const cfnAgentOrganizationalProfileProps: wellarchitected.CfnAgentOrganizationalProfileProps = {
  name: 'name',
  pillars: ['pillars'],

  // the properties below are optional
  businessOverview: 'businessOverview',
  deletionProtection: false,
  description: 'description',
  displayName: 'displayName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wellarchitected as wellarchitected

cfn_agent_organizational_profile_props = wellarchitected.CfnAgentOrganizationalProfileProps(
    name="name",
    pillars=["pillars"],

    # the properties below are optional
    business_overview="businessOverview",
    deletion_protection=False,
    description="description",
    display_name="displayName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.wellarchitected.*;

CfnAgentOrganizationalProfileProps cfnAgentOrganizationalProfileProps = CfnAgentOrganizationalProfileProps.builder()
        .name("name")
        .pillars(List.of("pillars"))

        // the properties below are optional
        .businessOverview("businessOverview")
        .deletionProtection(false)
        .description("description")
        .displayName("displayName")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WellArchitected;

var cfnAgentOrganizationalProfileProps = new CfnAgentOrganizationalProfileProps {
    Name = "name",
    Pillars = new [] { "pillars" },

    // the properties below are optional
    BusinessOverview = "businessOverview",
    DeletionProtection = false,
    Description = "description",
    DisplayName = "displayName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAgentOrganizationalProfileProps := &CfnAgentOrganizationalProfileProps{
	Name: jsii.String("name"),
	Pillars: []*string{
		jsii.String("pillars"),
	},

	// the properties below are optional
	BusinessOverview: jsii.String("businessOverview"),
	DeletionProtection: jsii.Boolean(false),
	Description: jsii.String("description"),
	DisplayName: jsii.String("displayName"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

businessOverviewoptionalstringbusiness_overviewoptionalstrbusinessOverviewoptionalStringBusinessOverviewoptionalstringBusinessOverviewoptional*string #
A business overview for the organizational profile used to improve recommendation quality.
deletionProtectionoptionalboolean | IResolvabledeletion_protectionoptionaltyping.Union[bool, IResolvable]deletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptionalinterface{} #
Whether deletion protection is enabled for the organizational profile.

When enabled, the profile cannot be deleted until deletion protection is disabled.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
A description of the organizational profile.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string #
The human-readable display name of the organizational profile.
namestringnamestrnameStringNamestringName*string required #
The name of the organizational profile.

Unique within the account and used as the last component of the ARN.

pillarsstring[]pillarstyping.List[str]pillarsList<String>Pillarsstring[]Pillars*[]*string required #
The list of Well-Architected pillars to focus on.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
Key-value pairs to associate with the Agent Organizational Profile.