aws_opensearchservice: High Level Constructs For OpenSearch SamlOptions Feature

[devardee]

Describe the feature

SAMLOptions is an existing Feature for OpenSearch Domain. Feature Documentation Link. According to the CDK docs currently there is no high level CDK construct for this feature.CDK Docs link for the SamlOptions

Use Case

The general recommendation is to use high level constructs and due to lack of High level construct for this feature, the CDK template needs to be migrated to use CFN constructs if there is a need to Create an OpenSearchDomain with SAMLOptionsProperty. This serves as a hinderance to the adoption of the SAMLOptionsProperty feature for AWS OpenSearch Domains.

Proposed Solution

Add the SAMLOptionsProperty to the AdvancedSecurityOptions interface object CDK Doc for AdvancedSecurityOptions Attribute .
A SamlOptions enabeld OpenSearchDomain created using CDK high level constructs should look like

const domain = new Domain(this, 'Domain', {
  version: EngineVersion.OPENSEARCH_1_0,
  enforceHttps: true,
  nodeToNodeEncryption: true,
  encryptionAtRest: {
    enabled: true,
  },
  fineGrainedAccessControl: {
    masterUserName: 'master-user',
    samlOptions: {
      enabled: true,
      idp: {
             entityId: 'entityId',
             metadataContent: 'metadataContent',
      },
     masterBackendRole: 'masterBackendRole',
     masterUserName: 'masterUserName',
     rolesKey: 'rolesKey',
     sessionTimeoutMinutes: 123,
     subjectKey: 'subjectKey',
   }
  },
  logging: {
    auditLogEnabled: true,
    slowSearchLogEnabled: true,
    appLogEnabled: true,
    slowIndexLogEnabled: true,
  },
});

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.84.0

Environment details (OS name and version, etc.)

macOS Ventura 13.4

[khushail]

thanks @devardee for submitting this feature request. You could get started with this contributing guide for the PR.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.