Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sdlf-foundations][cdk] metadata for seedfarmer #441

Merged
merged 1 commit into from
Oct 25, 2024
Merged

[sdlf-foundations][cdk] metadata for seedfarmer #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion sdlf-foundations/src/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@

app = cdk.App()
stack = cdk.Stack(app, stack_name)
Foundations(stack, "foundations")
stack_foundations = Foundations(stack, "foundations")

cdk.CfnOutput(
scope=stack,
id="metadata",
value=stack.to_json_string(stack_foundations.external_interface),
)

app.synth()
99 changes: 36 additions & 63 deletions sdlf-foundations/src/foundations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@


class Foundations(Construct):
external_interface = {}

def __init__(self, scope: Construct, id: str, **kwargs) -> None:
super().__init__(scope, id)

Expand Down Expand Up @@ -72,20 +74,8 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
# default=30,
# )

ssm.StringParameter(
self,
"rOrganizationSsm",
description="Name of the Organization owning the datalake",
parameter_name="/sdlf/storage/pOrg",
string_value=p_org.value_as_string,
)
ssm.StringParameter(
self,
"rDomainSsm",
description="Data domain name",
parameter_name="/sdlf/storage/pDomain",
string_value=p_domain.value_as_string,
)
self._external_interface("rOrganization", "Name of the Organization owning the datalake", p_org.value_as_string)
self._external_interface("rDomain", "Data domain name", p_domain.value_as_string)

######## LAKE FORMATION #########
lakeformation.CfnDataLakeSettings(
Expand Down Expand Up @@ -132,19 +122,15 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
)
self.lakeformationdataaccess_role.attach_inline_policy(lakeformationdataaccess_role_policy)

ssm.StringParameter(
self,
f"{lakeformationdataaccess_role_resource_name}ArnSsm",
description="Lake Formation Data Access Role",
parameter_name=f"/sdlf/storage/{lakeformationdataaccess_role_resource_name}Arn",
string_value=self.lakeformationdataaccess_role.role_arn,
self._external_interface(
f"{lakeformationdataaccess_role_resource_name}Arn",
"Lake Formation Data Access Role",
self.lakeformationdataaccess_role.role_arn,
)
ssm.StringParameter(
self,
f"{lakeformationdataaccess_role_resource_name}Ssm",
description="Lake Formation Data Access Role",
parameter_name=f"/sdlf/storage/{lakeformationdataaccess_role_resource_name}",
string_value=self.lakeformationdataaccess_role.role_name,
self._external_interface(
lakeformationdataaccess_role_resource_name,
"Lake Formation Data Access Role",
self.lakeformationdataaccess_role.role_name,
)

######## KMS #########
Expand Down Expand Up @@ -270,13 +256,7 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
)
self.kms_key.add_alias("alias/sdlf-kms-key").apply_removal_policy(RemovalPolicy.RETAIN_ON_UPDATE_OR_DELETE)

ssm.StringParameter(
self,
f"{kms_key_resource_name}Ssm",
description="ARN of the KMS key",
parameter_name=f"/sdlf/storage/{kms_key_resource_name}",
string_value=self.kms_key.key_arn,
)
self._external_interface(kms_key_resource_name, "ARN of the KMS key", self.kms_key.key_arn)

######## S3 #########
####### Access Logging Bucket ######
Expand Down Expand Up @@ -313,12 +293,9 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
bucket_key_enabled=True,
block_public_access=s3.BlockPublicAccess.BLOCK_ALL,
)
ssm.StringParameter(
self,
f"{access_logs_bucket_resource_name}Ssm",
description="S3 Access Logs Bucket",
parameter_name=f"/sdlf/storage/{access_logs_bucket_resource_name}",
string_value=self.access_logs_bucket.bucket_name,

self._external_interface(
access_logs_bucket_resource_name, "S3 Access Logs Bucket", self.access_logs_bucket.bucket_name
)

artifacts_bucket_name = (
Expand All @@ -337,12 +314,8 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
block_public_access=s3.BlockPublicAccess.BLOCK_ALL,
enforce_ssl=True,
)
ssm.StringParameter(
self,
f"{artifacts_bucket_resource_name}Ssm",
description="Name of the Artifacts S3 bucket",
parameter_name=f"/sdlf/storage/{artifacts_bucket_resource_name}",
string_value=artifacts_bucket.bucket_name,
self._external_interface(
artifacts_bucket_resource_name, "Name of the Artifacts S3 bucket", artifacts_bucket.bucket_name
)

raw_bucket = self.data_bucket(
Expand Down Expand Up @@ -383,12 +356,8 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
versioned=True,
event_bridge_enabled=True,
)
ssm.StringParameter(
self,
f"{athena_bucket_resource_name}Ssm",
description="Name of the Athena results S3 bucket",
parameter_name=f"/sdlf/storage/{athena_bucket_resource_name}",
string_value=athena_bucket.bucket_name,
self._external_interface(
athena_bucket_resource_name, "Name of the Athena results S3 bucket", athena_bucket.bucket_name
)

s3_lakeformationdataaccess_role_policy = iam.Policy(
Expand Down Expand Up @@ -452,12 +421,10 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
encryption_key=self.kms_key,
point_in_time_recovery=True,
)
ssm.StringParameter(
self,
f"{objectmetadata_table_resource_name}Ssm",
description="Name of the DynamoDB used to store metadata",
parameter_name=f"/sdlf/storage/{objectmetadata_table_resource_name}",
string_value=objectmetadata_table.table_name,
self._external_interface(
objectmetadata_table_resource_name,
"Name of the DynamoDB used to store metadata",
objectmetadata_table.table_name,
)

######## Lambda & SQS #########
Expand Down Expand Up @@ -654,6 +621,16 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
value=artifacts_bucket.bucket_name,
)

def _external_interface(self, resource_name, description, value):
ssm.StringParameter(
self,
f"{resource_name}Ssm",
description=description,
parameter_name=f"/sdlf/storage/{resource_name}",
string_value=value,
)
self.external_interface[resource_name] = value

def data_bucket(self, org, domain, region, account, bucket_layer):
data_bucket_name = f"{org}-{domain}-{region}-{account}-{bucket_layer}"
data_bucket_resource_name = f"r{bucket_layer.capitalize()}Bucket"
Expand All @@ -678,12 +655,8 @@ def data_bucket(self, org, domain, region, account, bucket_layer):
use_service_linked_role=False,
role_arn=self.lakeformationdataaccess_role.role_arn,
)
ssm.StringParameter(
self,
f"{data_bucket_resource_name}Ssm",
description=f"Name of the {bucket_layer.capitalize()} S3 bucket",
parameter_name=f"/sdlf/storage/{data_bucket_resource_name}",
string_value=data_bucket.bucket_name,
self._external_interface(
data_bucket_resource_name, f"Name of the {bucket_layer.capitalize()} S3 bucket", data_bucket.bucket_name
)

return data_bucket
Loading